Xero

이 커넥터는 Xero 백엔드에 대한 SQL 액세스를 제공합니다.

시작하기 전에

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

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. 커넥터: 사용 가능한 커넥터 드롭다운 목록에서 Xero를 선택합니다.
2. 커넥터 버전: 사용 가능한 버전의 드롭다운 목록에서 커넥터 버전을 선택합니다.
3. 연결 이름 필드에서 연결 인스턴스의 이름을 입력합니다.
  연결 이름은 다음 기준을 충족해야 합니다.
  - 연결 이름에 문자, 숫자, 하이픈을 사용할 수 있습니다.
  - 문자는 소문자여야 합니다.
  - 연결 이름은 문자로 시작하고 문자 또는 숫자로 끝나야 합니다.
  - 연결 이름은 63자를 초과할 수 없습니다.
4. 선택적으로 연결 인스턴스에 대한 설명을 입력합니다.
5. 서비스 계정: 필수 역할이 있는 서비스 계정을 선택합니다.
6. 필요한 경우 연결 노드 설정을 구성합니다.
  - 최소 노드 수: 최소 연결 노드 수를 입력합니다.
  - 최대 노드 수: 최대 연결 노드 수를 입력합니다.
  노드는 트랜잭션을 처리하는 연결의 단위(또는 복제본)입니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하기 위해서는 더 적은 노드가 필요합니다. 노드가 커넥터 가격 책정에 미치는 영향을 파악하려면 연결 노드 가격 책정을 참조하세요. 값을 입력하지 않으면 기본적으로 최소 노드가 (높은 가용성을 위해) 2로 설정되고 최대 노드는 50으로 설정됩니다.
7. 스키마: 데이터베이스 스키마로 액세스할 Xero API입니다.
8. 테넌트: 연결할 Xero 조직을 설정합니다. 이름 또는 테넌트 ID일 수 있습니다.
9. 세부정보 수준: 연결의 세부정보 수준(1~5)입니다. 세부정보 수준이 높을수록 모든 통신 세부정보(요청, 응답, SSL 인증서)가 로깅됩니다.
10. 선택적으로 + 라벨 추가를 클릭하여 키/값 쌍의 형식으로 연결에 라벨을 추가합니다.
11. 다음을 클릭합니다.
인증 섹션에서 인증 세부정보를 입력합니다.
1. 인증 유형을 선택하고 관련 세부정보를 입력합니다.
  Xero 연결에서 지원되는 인증 유형은 다음과 같습니다.
  - OAuth 2.0 클라이언트 사용자 인증 정보
  - OAuth 2.0 인증 코드 부여
2. 다음을 클릭합니다.
검토: 연결 및 인증 세부정보를 검토합니다.
만들기를 클릭합니다.

인증 구성

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

OAuth 2.0 클라이언트 사용자 인증 정보
- 클라이언트 ID: 사용자가 만든 앱에 대해 커넥터가 제공한 클라이언트 ID입니다.
- 클라이언트 보안 비밀번호: 생성한 연결된 앱의 클라이언트 보안 비밀이 포함된 Secret Manager 보안 비밀입니다.

OAuth 2.0 인증 코드 부여
- 액세스 토큰: 인증 코드 흐름 기반 연결로 요청을 인증하는 데 사용되는 액세스 토큰입니다.
- 클라이언트 ID: 액세스 토큰을 요청하는 데 사용되는 클라이언트 ID입니다.
- 클라이언트 보안 비밀번호: 액세스 토큰을 요청하는 데 사용되는 클라이언트 보안 비밀번호입니다.

항목, 작업, 조치

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

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

통합에서 Xero 연결 사용

시스템 제한사항

Xero 커넥터는 노드당 초당 5개의 트랜잭션을 처리할 수 있으며 이 한도를 초과하는 트랜잭션을 제한할 수 있습니다. 그러나 Xero 커넥터가 처리할 수 있는 트랜잭션 수는 Xero 인스턴스에 의해 적용되는 제약조건에 따라 달라집니다. 자세한 내용은 Xero API 비율 제한을 참조하세요. 기본적으로 Integration Connectors는 가용성을 높이기 위해 연결에 2개의 노드를 할당합니다.

Integration Connectors에 적용되는 한도에 대한 자세한 내용은 한도를 참조하세요.

참고: Integration Connectors 노드 수는 사용량에 따라 동적으로 자동 확장됩니다. 하지만 자동 확장을 기다리지 않고 대용량을 예약하려면 연결의 최소 노드 값을 조정하면 됩니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하려면 더 적은 노드가 필요합니다. 노드 값을 구성하려면 다음 안내를 따르세요.

사용한 만큼만 지불 고객인 경우 연결 수정 페이지에서 최소 및 최대 노드 값을 구성합니다.
정기 결제 기반 고객인 경우 지원팀에 문의하세요.

노드에서 처리할 수 있는 최대 트랜잭션은 다양한 요소에 따라 달라집니다. 따라서 처리량을 늘리기 위해 최소 노드를 조정하기 전에 백엔드 시스템이 필요한 트래픽을 처리하도록 최적으로 설정되었는지 확인하는 것이 좋습니다.

작업

이 섹션에는 커넥터가 지원하는 작업 중 일부가 나와 있습니다. 작업을 구성하는 방법은 작업 예시를 참조하세요.

참고: 모든 작업 결과는 통합을 실행한 후 Connectors 태스크의 connectorOutputPayload 응답 매개변수에서 JSON 응답으로 제공됩니다.

DownloadAttachment 작업

이 작업을 수행하면 연결을 다운로드합니다.

DownloadAttachment 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
파일 이름	문자열	No	다운로드할 연결의 이름입니다.
테이블	문자열	No	연결을 다운로드해야 하는 테이블의 이름입니다.
ObjectId	문자열	No	연결의 객체 ID입니다.

DownloadAttachment 작업의 출력 매개변수

이 작업은 다운로드가 성공하면 상태 200(OK)을 반환합니다.

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

UploadAttachment 작업

이 작업을 수행하면 연결을 업로드할 수 있습니다.

UploadAttachment 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
파일 이름	문자열	No	업로드할 연결의 이름입니다.
ObjectId	문자열	No	연결의 객체 ID입니다.
ContentType	문자열	No	연결의 콘텐츠 유형입니다.
테이블	문자열	No	연결을 업로드해야 하는 테이블의 이름입니다.
내용	문자열	No	연결 콘텐츠

UploadAttachment 작업의 출력 매개변수

이 작업은 객체 업로드가 성공하면 상태 200(OK)을 반환합니다.

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

ListAttachment 작업

이 작업을 수행하면 테이블의 모든 연결을 나열할 수 있습니다.

ListAttachment 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
ObjectId	문자열	No	연결의 객체 ID입니다.
테이블	문자열	No	연결을 나열해야 하는 테이블의 이름입니다.

ListAttachment 작업의 출력 매개변수

이 작업은 삭제가 성공하면 상태 200(OK)을 반환합니다.

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

SendInvoiceMail 작업

이 작업을 수행하면 인보이스를 보낸 사람에게 이메일을 보낼 수 있습니다.

SendInvoiceMail 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
InvoiceId	문자열	No	메일을 전송할 인보이스의 ID입니다.

SendInvoiceMail 작업의 출력 매개변수

이 작업은 이동 작업이 성공하면 상태 200(OK)을 반환합니다.

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

UploadFile 작업

이 작업을 수행하면 파일을 업로드할 수 있습니다.

UploadFile 작업의 입력 매개변수

매개변수 이름	데이터 유형	필수	설명
이름	문자열	No	업로드할 파일의 이름입니다.
내용	문자열	No	업로드할 파일 콘텐츠입니다.

UploadFile 작업의 출력 매개변수

이 작업은 객체 업로드가 성공하면 상태 200(OK)을 반환합니다.

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

작업 예시

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

예시 - 연결 다운로드

이 예시에서는 연결을 다운로드합니다.

Configure connector task 대화상자에서 Actions를 클릭합니다.
DownloadAttachment 조치를 선택한 다음 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
"Filename": "Xero_Test.txt",
"Table": "Contacts",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
}
```

작업이 성공하면 DownloadAttachment 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": "True",
"Content": "Test content"
}]

예시 - 연결 업로드

이 예시에서는 연결을 업로드합니다.

Configure connector task 대화상자에서 Actions를 클릭합니다.
UploadAttachment 조치를 선택한 다음 완료를 클릭합니다.

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

{
"Filename": "Xero_Test.txt",
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"ContentType": "txt",
"Table": "Contacts",
"Content": "Test content upload attachment"
}

작업이 성공하면 UploadAttachment 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": null,
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Test.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27",
"IncludeOnline": null,
"_": ""
}, {
"Success": null,
"AttachmentId": null,
"FileName": null,
"URL": null,
"MimeType": null,
"ContentLength": null,
"IncludeOnline": null,
"_": null
}]

예시 - 연결 나열

이 예시에서는 지정된 테이블의 연결을 나열합니다.

Configure connector task 대화상자에서 Actions를 클릭합니다.
ListAttachment 조치를 선택한 다음 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
"ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
"Table": "Contacts"
}
```

작업이 성공하면 ListAttachment 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Limit_Testing.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27"
}]

예시 - 인보이스 이메일 전송

이 예시에서는 지정된 인보이스에 대한 이메일을 전송합니다.

Configure connector task 대화상자에서 Actions를 클릭합니다.
SendInvoiceMail 조치를 선택한 다음 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
"InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
}
```

작업이 성공하면 SendInvoiceMail 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": "true"
}]

예시 - 파일 업로드

이 예시에서는 파일을 업로드합니다.

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

작업이 성공하면 UploadFile 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": "true",
"FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460",
"Name": "Sample1.txt",
"FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d",
"MimeType": "text/plain",
"Size": 26.0,
"User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6",
"User_Name": "test_user_1@test.com",
"User_FirstName": "John",
"User_LastName": "Smith",
"User_FullName": "John Smith",
"Created": "2023-12-18 17:38:53.01",
"Updated": "2023-12-18 17:38:53.01"
}]

항목 작업 예시

이 섹션에서는 이 커넥터에서 일부 항목 작업을 수행하는 방법을 보여줍니다.

예시 - 모든 레코드 나열

이 예시에서는 Accounts 항목의 모든 레코드를 나열합니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 Accounts를 선택합니다.
List 작업을 선택한 후 완료를 클릭합니다.
원하는 경우 커넥터 태스크의 태스크 입력 섹션에서 필터 절을 지정하여 결과 집합을 필터링할 수 있습니다. 예를 들면 City='Bangalore'입니다. 논리 연산자를 사용하여 필터 조건을 여러 개 지정할 수도 있습니다. 예를 들면 City='Bangalore' and region='asia-south2'입니다.

예시 - 인보이스 가져오기

이 예시에서는 Invoices 항목에서 지정된 ID가 포함된 인보이스를 가져옵니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 Invoices를 선택합니다.
Get 작업을 선택한 후 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 EntityId를 클릭한 후 기본값 필드에 1|016a64c7-be0b-45a2-acae-13057fdf1566을 입력합니다.
여기서 1|016a64c7-be0b-45a2-acae-13057fdf1566는 Invoices 항목의 기본 키 값입니다.

예시 - 인보이스 만들기

이 예시에서는 Invoices 항목에 인보이스를 만듭니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 Invoices를 선택합니다.
Create 작업을 선택한 후 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
"Type": "ACCPAY",
"ContactName": "ContactName1",
"LineItem_Description": "LineItemDescription"
}
```
통합이 완료되면 커넥터 태스크의 connectorOutputPayload 필드에 다음과 유사한 값이 포함됩니다.
```
{
"Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
}
```

예시 - 레코드 업데이트

이 예시에서는 AssetTypes 항목의 레코드를 업데이트합니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 AssetTypes를 선택합니다.
Update 작업을 선택한 후 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.
```
{
"BookDepreciationSetting_DepreciationRate": 10.0
}
```
entityId를 클릭한 후 기본값 필드에 f8d43548-25b0-4cc3-8f59-d97106974fe8을 입력합니다.
통합이 성공하면 커넥터 태스크의 connectorOutputPayload 필드에 다음과 유사한 값이 포함됩니다.
```
{
"AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
}
```

예시 - 파일 삭제

이 예시에서는 Files 항목에서 지정된 ID가 있는 파일을 삭제합니다.

Configure connector task 대화상자에서 Entities를 클릭합니다.
Entity 목록에서 Files를 선택합니다.
Delete 작업을 선택한 후 완료를 클릭합니다.
커넥터 태스크의 태스크 입력 섹션에서 entityId를 클릭한 후 기본값 필드에 421c82f0-38fb-4074-a679-63b04c0d8832을 입력합니다.

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

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

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

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

다음 단계

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