Box

Box 커넥터를 사용하면 Box 백엔드에 연결하고 SQL을 사용하여 Box 데이터를 검색하고 업데이트할 수 있습니다.

지원되는 버전

시작하기 전에

Box 커넥터를 사용하기 전에 다음 태스크를 수행합니다.

Google Cloud 프로젝트에서:
- 커넥터를 구성하는 사용자에게 roles/connectors.admin IAM 역할을 부여합니다.
- 커넥터에 사용할 서비스 계정에 다음 IAM 역할을 부여합니다.
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  서비스 계정은 인증을 거쳐야 하며 Google API의 데이터에 액세스할 수 있는 승인을 받은 사람이 아닌 사용자를 나타내는 특별한 유형의 Google 계정입니다. 서비스 계정이 없으면 서비스 계정을 만들어야 합니다. 자세한 내용은 서비스 계정 만들기를 참조하세요.
- 다음 서비스를 사용 설정합니다.
  - secretmanager.googleapis.com(Secret Manager API)
  - connectors.googleapis.com(Connectors API)
  서비스 사용 설정 방법은 서비스 사용 설정을 참조하세요.
이러한 서비스나 권한이 이전 프로젝트에서 사용 설정되지 않았으면 커넥터를 구성할 때 서비스나 권한을 사용 설정하라는 메시지가 표시됩니다.

커넥터 구성

커넥터를 구성하려면 데이터 소스(백엔드 시스템)에 대한 연결을 만들어야 합니다. 연결은 데이터 소스와 관련이 있습니다. 즉, 데이터 소스가 많으면 데이터 소스마다 별도의 연결을 만들어야 합니다. 연결을 만들려면 다음 단계를 따르세요.

Cloud 콘솔에서 Integration Connectors > 연결 페이지로 이동한 다음 Google Cloud 프로젝트를 선택하거나 만듭니다.
연결 페이지로 이동
+ 새로 만들기를 클릭하여 연결 만들기 페이지를 엽니다.
위치 섹션에서 연결 위치를 선택합니다.
1. 리전: 드롭다운 목록에서 위치를 선택합니다.
  지원되는 모든 리전 목록은 위치를 참조하세요.
2. 다음을 클릭합니다.
연결 세부정보 섹션에서 다음을 완료합니다.
1. 커넥터: 사용 가능한 커넥터 드롭다운 목록에서 Box를 선택합니다.
2. 커넥터 버전: 사용 가능한 버전의 드롭다운 목록에서 커넥터 버전을 선택합니다.
3. 연결 이름 필드에서 연결 인스턴스의 이름을 입력합니다.
  연결 이름은 다음 기준을 충족해야 합니다.
  - 연결 이름에 문자, 숫자, 하이픈을 사용할 수 있습니다.
  - 문자는 소문자여야 합니다.
  - 연결 이름은 문자로 시작하고 문자 또는 숫자로 끝나야 합니다.
  - 연결 이름은 63자를 초과할 수 없습니다.
4. 선택적으로 연결 인스턴스에 대한 설명을 입력합니다.
5. 서비스 계정: 필수 역할이 있는 서비스 계정을 선택합니다.
6. 필요한 경우 연결 노드 설정을 구성합니다.
  - 최소 노드 수: 최소 연결 노드 수를 입력합니다.
  - 최대 노드 수: 최대 연결 노드 수를 입력합니다.
  노드는 트랜잭션을 처리하는 연결의 단위(또는 복제본)입니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하기 위해서는 더 적은 노드가 필요합니다. 노드가 커넥터 가격 책정에 미치는 영향을 파악하려면 연결 노드 가격 책정을 참조하세요. 값을 입력하지 않으면 기본적으로 최소 노드가 (높은 가용성을 위해) 2로 설정되고 최대 노드는 50으로 설정됩니다.
7. 사용자 가장 모드: 사용자 가장 유형을 지정합니다. 사용자 모드 또는 관리자 모드여야 합니다.
8. 프록시 사용: 이 체크박스를 선택하여 연결의 프록시 서버를 구성하고 다음 값을 구성합니다.
9. 선택적으로 + 라벨 추가를 클릭하여 키/값 쌍의 형식으로 연결에 라벨을 추가합니다.
10. 다음을 클릭합니다.
인증 섹션에서 인증 세부정보를 입력합니다.
1. 인증 유형을 선택하고 관련 세부정보를 입력합니다.
  Box 연결에서는 다음 인증 유형이 지원됩니다.
  - OAuth 2.0 - 클라이언트 사용자 인증 정보
  - OAuth 2.0 - 승인 코드
2. 다음을 클릭합니다.
검토: 연결 및 인증 세부정보를 검토합니다.
만들기를 클릭합니다.

인증 구성

사용할 인증을 기반으로 세부정보를 입력합니다.

OAuth 2.0 - 클라이언트 사용자 인증 정보
- 클라이언트 ID: 사용자가 만든 앱에 대해 커넥터가 제공한 클라이언트 ID입니다.
- 클라이언트 보안 비밀번호: 생성한 연결된 앱의 클라이언트 보안 비밀이 포함된 Secret Manager 보안 비밀입니다.
- 비공개 키: 비공개 키 파일 콘텐츠가 포함된 Secret Manager 보안 비밀입니다. 비공개 키는 커넥터에 제공된 공개 키/인증서와 일치해야 합니다.
- 비공개 키 비밀번호: 비공개 키 파일의 비밀번호(구두점)가 포함된 Secret Manager 보안 비밀입니다.
- Box 애플리케이션 액세스 수준: Box 앱의 애플리케이션 액세스 수준입니다.
- 엔터프라이즈 ID/사용자 ID: 앱 수준이 엔터프라이즈인 경우 엔터프라이즈 ID, 앱 수준이 사용자인 경우 사용자 ID입니다.
- OAuth JWT 공개 키 ID: JWT에 대한 공개 키의 ID입니다.
- 인증 스키마: Box 커넥터용 인증 스키마입니다.
- OAuth 시작: Box 커넥터용 OAuth 매개변수를 시작합니다.
- OAuth JWT 인증서 유형: Box 커넥터용 OAuth JWT 인증서 유형입니다.
OAuth 2.0 - 승인 코드

클라이언트 ID: 외부 애플리케이션이 제공한 클라이언트 ID입니다.
범위: 권한 범위입니다. 예를 들면 root_readonly입니다. 범위 작동 방법을 이해하고 Box에 사용 가능한 모든 범위를 보려면 범위를 참조하세요.
클라이언트 보안 비밀번호: Secret Manager 보안 비밀을 참조하세요. 이 승인을 구성하려면 먼저 Secret Manager 보안 비밀이 생성되어 있어야 합니다.
보안 비밀 버전: 클라이언트 보안 비밀번호에 대한 Secret Manager 보안 비밀 버전입니다.

Authorization code 인증 유형의 경우 연결을 만든 후 인증 구성을 위한 몇 가지 추가 단계를 수행해야 합니다. 자세한 내용은 연결 만들기 이후 추가 단계를 참조하세요.

참고: Authorization code 인증 유형을 사용하는 중이고 Box 애플리케이션에서 구성을 변경한 경우 Box 연결을 다시 승인해야 합니다. 다시 승인하는 방법은 승인 코드의 다시 승인을 참조하세요.

연결 생성 후 추가 단계

인증에 OAuth 2.0 - Authorization code를 선택한 경우 연결을 만든 후 다음 추가 단계를 수행해야 합니다.

연결 페이지에서 새로 만든 연결을 찾습니다.
새 커넥터의 상태는 승인 필요입니다.
승인 필요를 클릭합니다.
그러면 승인 수정 창이 표시됩니다.
리디렉션 URI 값을 외부 애플리케이션에 복사합니다.
승인 세부정보를 확인합니다.
승인을 클릭합니다.
승인이 성공하면 연결 페이지에서 연결 상태가 활성으로 설정됩니다.

승인 코드 재승인

Authorization code 인증 유형을 사용하는 중이고 Box 애플리케이션에서 구성을 변경한 경우 Box 연결을 다시 승인해야 합니다. 연결을 다시 승인하려면 다음 단계를 수행하세요.

연결 페이지에서 필요한 연결을 클릭합니다.
그러면 연결 세부정보 페이지가 열립니다.
수정을 클릭하여 연결 세부정보를 수정합니다.
인증 섹션에서 OAuth 2.0 - 승인 코드 세부정보를 확인합니다.
필요한 경우 변경합니다.
저장을 클릭합니다. 그러면 연결 세부정보 페이지로 이동합니다.
인증 섹션에서 승인 수정을 클릭합니다. 그러면 승인 창이 표시됩니다.
승인을 클릭합니다.
승인이 성공하면 연결 페이지에서 연결 상태가 활성으로 설정됩니다.

항목, 작업, 조치

모든 Integration Connectors는 연결된 애플리케이션의 객체에 대한 추상화 레이어를 제공합니다. 이 추상화를 통해서만 애플리케이션의 객체에 액세스할 수 있습니다. 추상화는 항목, 작업, 조치로 노출됩니다.

항목: 연결된 애플리케이션 또는 서비스에서 항목은 객체 또는 속성 모음으로 간주될 수 있습니다. 항목의 정의는 커넥터마다 다릅니다. 예를 들어 데이터베이스 커넥터에서는 테이블이 항목이고, 파일 서버 커넥터에서는 폴더가 항목이며 메시징 시스템 커넥터에서는 큐가 항목입니다.
그러나 커넥터가 항목을 지원하지 않거나 항목을 포함하지 않을 수 있으며, 이 경우 Entities 목록이 비어 있습니다.
작업: 작업은 항목에 대해 수행할 수 있는 활동입니다. 항목에서 다음 작업을 수행할 수 있습니다.
- 목록
- 가져오기
- 만들기
- 업데이트
- 삭제
사용 가능한 목록에서 항목을 선택하면 항목에 사용 가능한 작업 목록이 생성됩니다. 작업에 대한 자세한 설명은 커넥터 태스크의 항목 작업을 참조하세요. 그러나 커넥터가 항목 작업을 지원하지 않으면 이렇게 지원되지 않는 작업은 Operations 목록에 나열되지 않습니다.
조치: 커넥터 인터페이스를 통해 통합에 제공되는 첫 번째 클래스 함수입니다. 조치를 사용하면 항목을 변경할 수 있습니다. 조치는 커넥터마다 다릅니다. 하지만 커넥터가 조치를 지원하지 않을 수 있으며 이 경우 Actions 목록이 비어 있습니다.

작업

이 섹션에는 Box 연결에서 지원하는 모든 작업이 나와 있습니다.

DownloadFile 작업

이 작업을 통해 Box 인스턴스에서 파일을 다운로드할 수 있습니다.

DownloadFile 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
FileID	문자열	예	다운로드할 파일의 ID입니다.
HasBytes	불리언	예	파일을 문자열로 다운로드할지 Base64로 인코딩된 문자열로 다운로드할지 지정합니다.

DownloadFile 작업의 출력 매개변수

이 작업은 결과를 나타내는 응답 본문과 함께 상태 200(OK)을 반환합니다.

매개변수 이름	데이터 유형	설명
성공	문자열	파일 다운로드가 성공했는지 여부를 지정합니다.
ContentBytes	문자열	Base64 인코딩 문자열로 표현된 파일 콘텐츠입니다.

DownloadFile 작업을 구성하는 방법의 예시는 작업 예시를 참조하세요.

UploadFile 작업

이 작업을 통해 Box 인스턴스에 파일을 업로드할 수 있습니다.

UploadFile 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
ParentID	문자열	예	파일을 업로드할 폴더의 ID입니다. 이 매개변수를 지정하지 않으면 파일이 Box 계정의 루트에 업로드됩니다. 기본값은 0입니다.
내용	문자열	예	업로드할 파일 콘텐츠입니다.

UploadFile 작업의 출력 매개변수

이 작업은 결과를 나타내는 응답 본문과 함께 상태 200(OK)을 반환합니다.

매개변수 이름	데이터 유형	설명
성공	문자열	파일 업로드가 성공했는지 여부를 지정합니다.
ID	문자열	새로 만든 파일의 ID입니다.
VersionID	문자열	특정 파일 버전의 ID입니다.
Hash	문자열	파일의 `SHA1` 해시입니다.
ETag	문자열	파일 또는 폴더의 Etag 값입니다. 기본값은 0입니다.

UploadFile 작업을 구성하는 방법의 예시는 작업 예시를 참조하세요.

CopyFile 작업

이 작업을 통해 Box 인스턴스에서 파일을 복사할 수 있습니다.

CopyFile 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
FileID	문자열	예	복사할 파일의 ID입니다.
DestinationFolderId	문자열	아니요	파일을 복사할 대상 폴더의 ID입니다. 값을 지정하지 않으면 최신 버전의 파일이 복사됩니다.
NewName	문자열	예	복사된 파일의 새 파일 이름입니다.

CopyFile 작업의 출력 매개변수

이 작업은 결과를 나타내는 응답 본문과 함께 상태 200(OK)을 반환합니다.

매개변수 이름	데이터 유형	설명
성공	문자열	파일 복사가 성공했는지 여부를 지정합니다.
ID	문자열	복사된 파일의 ID입니다.

CopyFile 작업을 구성하는 방법의 예시는 작업 예시를 참조하세요.

CopyFolder 작업

이 작업을 사용하면 Box 인스턴스에서 전체 폴더를 복사할 수 있습니다.

CopyFolder 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
FolderID	문자열	예	복사하려는 폴더의 ID입니다.
DestinationFolderId	문자열	예	폴더를 복사할 대상 폴더의 ID입니다.
NewName	문자열	아니요	복사된 폴더의 새 파일 이름입니다.

CopyFolder 작업의 출력 매개변수

이 작업은 결과를 나타내는 응답 본문과 함께 상태 200(OK)을 반환합니다.

매개변수 이름	데이터 유형	설명
성공	문자열	폴더 복사가 성공했는지 여부를 지정합니다.
ID	문자열	복사된 폴더의 ID입니다.

CopyFolder 작업을 구성하는 방법의 예시는 작업 예시를 참조하세요.

작업 예시

이 섹션에서는 이 커넥터에서 일부 작업을 수행하는 방법을 설명합니다.

예 - 파일 다운로드

Configure connector task 대화상자에서 Actions를 클릭합니다.
DownloadFile 조치를 선택한 다음 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
"FileID": "1283194869422",
"HasBytes": true
}
```

이 예시에서는 파일을 Base64로 인코딩된 문자열로 다운로드합니다. 작업이 성공하면 커넥터 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

참고: 바이너리 파일이 아닌 파일을 다운로드하려면 HasBytes 값을 false로 설정합니다.

예 - 파일 업로드

Configure connector task 대화상자에서 Actions를 클릭합니다.
UploadFile 조치를 선택한 다음 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
"ParentId": "0",
"Content": "12345"
}
```

이 예시는 문자열 콘텐츠를 파일로 업로드합니다. 작업이 성공하면 커넥터 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

예 - 파일 복사

Configure connector task 대화상자에서 Actions를 클릭합니다.
CopyFile 조치를 선택한 다음 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
"FileID": "1288751886061",
"DestinationFolderId": "219105724517",
"NewName": "NewCopiedFile"
}
```

이 예시에서는 ID가 1288751886061인 파일을 ID가 219105724517인 폴더에 복사합니다. 작업이 성공하면 커넥터 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": "true",
"ID": "1308006018536"
}]

예 - 폴더 복사

Configure connector task 대화상자에서 Actions를 클릭합니다.
CopyFolder 조치를 선택한 다음 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
"FolderID": "218475301279",
"DestinationFolderId": "0",
"NewName": "NewCopiedFolder"
}
```

이 예시에서는 ID가 218475301279인 폴더를 ID가 219105724517인 폴더에 복사합니다. 작업이 성공하면 커넥터 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": "true",
"ID": "226312444517"
}]

항목 작업 예시

예 - 모든 파일 나열

이 예시에서는 Files 항목의 파일을 나열합니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 Files를 선택합니다.
LIST 작업을 선택한 후 완료를 클릭합니다.
필요한 경우 filterClause에 값을 입력하여 결과 집합을 필터링할 수 있습니다.

예 - 티켓 가져오기

이 예시에서는 Tickets 항목에서 특정 티켓을 가져옵니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 Tickets를 선택합니다.
GET 작업을 선택한 후 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 EntityId를 클릭한 후 기본값 필드에 35을 입력합니다.
여기서 35는 Tickets 항목의 기본 키 값입니다.

예 - 티켓 만들기

이 예시에서는 Tickets 항목에 티켓을 만듭니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 Tickets를 선택합니다.
Create 작업을 선택한 후 완료를 클릭합니다.

커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.

{
"Subject": "Create_Ticket_01",
"Description": "Test",
"Type": "incident",
"Priority": "urgent",
"Status": "open",
"Recipient": null,
"HasIncidents": false,
"DueAt": null,
"RequesterId": 3.84625885158E11,
"SubmitterId": 3.84625883418E11,
"AssigneeId": 3.84625883418E11,
"OrganizationId": "16665992392721",
"GroupId": 3.60008282358E11,
"TicketFormId": 3.60001719218E11,
"BrandId": 3.60003285058E11
}

통합이 성공하면 커넥터 태스크의 connectorOutputPayload 필드에 다음과 유사한 값이 포함됩니다.

{
"Id": 38.0
}

예 - 티켓 업데이트

이 예시에서는 Tickets 항목에서 지정된 티켓을 업데이트합니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 티켓을 선택합니다.
Update 작업을 선택한 후 완료를 클릭합니다.

커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.

{
        "Subject": "Update_Ticket_02",
        "Description": "Updating the ticket",
        "RequesterId": 1.6854335860497E13
      }

entityId를 클릭한 후 기본값 필드에 35을 입력합니다.
또는 entityId를 지정하는 대신 filterClause를 35로 설정할 수도 있습니다.

통합이 성공하면 커넥터 태스크의 connectorOutputPayload 필드에 다음과 유사한 값이 포함됩니다.
```
{
Id": 35.0
}
      
```

예시 - 티켓 삭제

이 예시에서는 Tickets 항목에서 지정된 티켓을 삭제합니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 티켓을 선택합니다.
Delete 작업을 선택한 후 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 entityId를 클릭한 후 기본값 필드에 35을 입력합니다.

참고: Delete 작업은 레코드를 소프트 삭제합니다. 필요한 경우 삭제한 레코드를 나중에 복구할 수 있습니다.

terraform을 사용하여 연결 만들기

Terraform 리소스를 사용하여 새 연결을 만들 수 있습니다.

Terraform 구성을 적용하거나 삭제하는 방법은 기본 Terraform 명령어를 참조하세요.

연결 만들기를 위한 샘플 Terraform 템플릿을 보려면 샘플 템플릿을 참조하세요.

Terraform을 사용하여 이 연결을 만들 때는 Terraform 구성 파일에서 다음 변수를 설정해야 합니다.

매개변수 이름	데이터 유형	필수	설명
impersonate_user_mode	ENUM	참	사용자 가장 유형을 지정합니다. 사용자 모드 또는 관리자 모드여야 합니다. 지원되는 값은 사용자, 관리자입니다.
proxy_enabled	부울	거짓	이 체크박스를 선택하여 연결의 프록시 서버를 구성합니다.
proxy_auth_scheme	ENUM	거짓	ProxyServer 프록시에 인증하는 데 사용할 인증 유형입니다. 지원되는 값은 BASIC, DIGEST, NONE입니다.
proxy_user	STRING	거짓	ProxyServer 프록시에 인증하는 데 사용할 사용자 이름입니다.
proxy_password	SECRET	거짓	ProxyServer 프록시에 인증하는 데 사용할 비밀번호입니다.
proxy_ssltype	ENUM	거짓	ProxyServer 프록시에 연결할 때 사용할 SSL 유형입니다. 지원되는 값은 AUTO, ALWAYS, NEVER, TUNNEL입니다.

통합에서 Box 연결 사용

연결을 만들면 Apigee Integration 및 Application Integration에서 사용할 수 있게 됩니다. 커넥터 태스크를 통해 통합에서 연결을 사용할 수 있습니다.

Apigee Integration에서 커넥터 태스크를 만들고 사용하는 방법을 알아보려면 커넥터 태스크를 참조하세요.
Application Integration에서 커넥터 태스크를 만들고 사용하는 방법을 이해하려면 커넥터 태스크를 참조하세요.

Google Cloud 커뮤니티에서 도움 받기

Google Cloud 커뮤니티에서 Cloud 포럼에 질문을 게시하고 이 커넥터에 대해 토론할 수 있습니다.

다음 단계

연결 일시중지 및 재개 방법 알아보기
커넥터 사용량 모니터링 방법 알아보기
커넥터 로그 확인 방법 알아보기