Zendesk

Zendesk 커넥터를 사용하면 Zendesk 데이터베이스에서 삽입, 삭제, 업데이트, 읽기 작업을 수행할 수 있습니다.

지원되는 버전

이 커넥터는 Zendesk의 버전 2 API를 지원합니다.

시작하기 전에

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

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)
  서비스 사용 설정 방법은 서비스 사용 설정을 참조하세요.
이러한 서비스나 권한이 이전 프로젝트에서 사용 설정되지 않았으면 커넥터를 구성할 때 서비스나 권한을 사용 설정하라는 메시지가 표시됩니다.
이메일 주소와 비밀번호를 사용하여 Zendesk API에 액세스하려면 Zendesk 관리 센터에서 password access를 사용 설정합니다. 자세한 내용은 기본 인증을 참조하세요.
Zendesk 계정 만들기에 대한 자세한 내용은 Zendesk 계정 만들기를 참고하세요.

커넥터 구성

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

Cloud 콘솔에서 Integration Connectors > 연결 페이지로 이동한 다음 Google Cloud 프로젝트를 선택하거나 만듭니다.
연결 페이지로 이동
+ 새로 만들기를 클릭하여 연결 만들기 페이지를 엽니다.
위치 섹션에서 연결 위치를 선택합니다.
1. 리전: 드롭다운 목록에서 위치를 선택합니다.
  지원되는 모든 리전 목록은 위치를 참조하세요.
2. 다음을 클릭합니다.
연결 세부정보 섹션에서 다음을 완료합니다.
1. 커넥터: 사용 가능한 커넥터 드롭다운 목록에서 Zendesk를 선택합니다.
2. 커넥터 버전: 사용 가능한 버전의 드롭다운 목록에서 커넥터 버전을 선택합니다.
3. 연결 이름 필드에서 연결 인스턴스의 이름을 입력합니다.
  연결 이름은 다음 기준을 충족해야 합니다.
  - 연결 이름에 문자, 숫자, 하이픈을 사용할 수 있습니다.
  - 문자는 소문자여야 합니다.
  - 연결 이름은 문자로 시작하고 문자 또는 숫자로 끝나야 합니다.
  - 연결 이름은 49자(영문 기준)를 초과할 수 없습니다.
  - 이벤트 구독을 지원하는 커넥터의 경우 연결 이름은 'goog' 프리픽스로 시작할 수 없습니다.
4. 선택적으로 연결 인스턴스에 대한 설명을 입력합니다.
5. 필요한 경우 Cloud Logging을 사용 설정한 다음 로그 수준을 선택합니다. 기본적으로 로그 수준은 Error로 설정됩니다.
6. 서비스 계정: 필수 역할이 있는 서비스 계정을 선택합니다.
7. 이벤트 구독에 연결을 사용하려면 이벤트 구독 사용 설정을 선택합니다. 이 옵션을 선택하면 다음 옵션이 표시됩니다.
  - 항목 및 작업으로 이벤트 구독 사용 설정: 이벤트 구독 및 커넥터 작업(항목 및 작업) 모두에 연결을 사용하려면 이 옵션을 선택합니다.
  - 이벤트 구독만 사용 설정: 이벤트 구독에만 연결을 사용하려면 이 옵션을 선택합니다. 이 옵션을 선택하는 경우 다음을 클릭한 다음 이벤트 구독을 구성합니다.
8. 필요한 경우 연결 노드 설정을 구성합니다.
  - 최소 노드 수: 최소 연결 노드 수를 입력합니다.
  - 최대 노드 수: 최대 연결 노드 수를 입력합니다.
  노드는 트랜잭션을 처리하는 연결의 단위(또는 복제본)입니다. 연결에 대해 더 많은 트랜잭션을 처리하려면 더 많은 노드가 필요합니다. 이와 반대로 더 적은 트랜잭션을 처리하기 위해서는 더 적은 노드가 필요합니다. 노드가 커넥터 가격 책정에 미치는 영향을 파악하려면 연결 노드 가격 책정을 참조하세요. 값을 입력하지 않으면 기본적으로 최소 노드가 (높은 가용성을 위해) 2로 설정되고 최대 노드는 50으로 설정됩니다.
9. 프록시 사용: 이 체크박스를 선택하여 연결의 프록시 서버를 구성하고 다음 값을 구성합니다.
10. 선택적으로 + 라벨 추가를 클릭하여 키/값 쌍의 형식으로 연결에 라벨을 추가합니다.
11. 다음을 클릭합니다.
대상 섹션에서 연결하려는 원격 호스트(백엔드 시스템)의 세부정보를 입력합니다.
1. 대상 유형: 대상 유형을 선택합니다.
  - 목록에서 호스트 주소를 선택하여 대상의 호스트 이름 또는 IP 주소를 지정합니다.
  - 백엔드 시스템에 비공개 연결을 설정하려면 목록에서 엔드포인트 연결을 선택한 다음 엔드포인트 연결 목록에서 필요한 엔드포인트 연결을 선택합니다.
    참고: 엔드포인트 연결을 만드는 방법은 PSC 서비스 연결 및 엔드포인트 연결을 참조하세요. 엔드포인트 연결을 만들면 엔드포인트 연결 목록에 표시됩니다.
  추가 보안을 사용하여 백엔드 시스템에 공개 연결을 설정하려면 연결의 고정 아웃바운드 IP 주소를 구성한 후 방화벽 규칙을 구성하여 특정 고정 IP 주소만 허용 목록에 추가합니다.
  
  추가 대상을 입력하려면 +대상 추가를 클릭합니다.
2. 다음을 클릭합니다.
인증 섹션에서 인증 세부정보를 입력합니다.
1. 인증 유형을 선택하고 관련 세부정보를 입력합니다.
  Zendesk 연결에서 지원되는 인증 유형은 다음과 같습니다.
  - 사용자 이름 및 비밀번호
  - 사용자 및 API 토큰
2. 다음을 클릭합니다.
이벤트 구독을 사용 설정한 경우 이벤트 구독 세부정보 섹션이 연결 만들기 페이지에 표시됩니다. 이벤트 구독 세부정보를 구성하는 방법은 이벤트 구독 구성을 참조하세요.
검토: 연결 및 인증 세부정보를 검토합니다.
만들기를 클릭합니다.

인증 구성

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

사용자 이름 및 비밀번호
- 사용자 이름: 연결에 사용할 Zendesk 사용자 이름입니다.
- 비밀번호: Zendesk 사용자 이름과 연결된 비밀번호가 포함된 Secret Manager 보안 비밀입니다.
사용자 및 API 토큰
- 사용자: 인증에 사용된 Zendesk 사용자 계정입니다.
- API 토큰: 인증된 사용자의 API 토큰입니다.

이벤트 구독 구성

이벤트 구독을 사용 설정한 경우 이벤트 구독 세부정보 섹션에 다음 값을 입력합니다.

대상 유형을 선택합니다.
- 호스트 주소: host 필드에 백엔드 시스템의 등록 URL을 입력합니다.
인증 세부정보를 입력합니다.
1. 사용자 이름: 사용자 이름을 입력합니다.
2. 비밀번호: 사용자 이름과 연결된 비밀번호가 포함된 Secret Manager 보안 비밀을 선택합니다.
3. 보안 비밀 버전: 보안 비밀 버전을 선택합니다.
필요한 경우 백엔드 시스템 응답에 추가 정보를 추가하려면 데이터 보강 사용 설정을 선택합니다.
추가 정보는 이벤트를 구성한 항목에 따라 달라집니다. 자세한 내용은 이벤트 알림의 데이터 보강을 참조하세요.

참고: 이 연결을 이벤트 구독에만 구성한 경우에는 이 옵션을 사용 설정할 수 없습니다. 데이터 보강을 사용 설정하려면 이벤트 구독과 커넥터 작업(항목 및 작업) 모두에 연결을 구성해야 합니다.
백엔드 애플리케이션과 연결 간의 보안 연결을 위해 비공개 연결 사용 설정을 선택합니다. 이 옵션을 선택하면 연결을 만든 후 추가 구성 단계를 수행해야 합니다. 자세한 내용은 이벤트 구독용 비공개 연결을 참조하세요.
데드 레터 구성을 입력합니다. 데드 레터를 구성하면 연결에서 처리되지 않은 이벤트를 지정된 Pub/Sub 주제에 씁니다. 다음 세부정보를 입력합니다.
1. 데드 레터 프로젝트 ID: 데드 레터 Pub/Sub 주제를 구성한 Google Cloud 프로젝트 ID입니다.
2. 데드 레터 주제: 처리되지 않은 이벤트의 세부정보를 쓰려는 Pub/Sub 주제입니다.
프록시를 사용하여 백엔드에 연결하려면(이벤트 구독) 다음 세부정보를 입력합니다.

프록시 SSL 유형: 프록시 서버에 연결할 때 사용할 SSL 유형입니다. 다음 인증 유형 중 하나를 선택합니다.
- 항상: 이벤트 구독에 대해 연결에 항상 SSL이 사용 설정됩니다.
- 사용 안 함: 이벤트 구독에 대해 연결에 SSL이 사용 설정되지 않습니다.
프록시 인증 스킴: 프록시 서버로 인증할 인증 유형을 선택합니다. 지원되는 인증 유형은 다음과 같습니다.
- 기본: 기본 HTTP 인증입니다.
프록시 사용자: 프록시 서버로 인증하는 데 사용할 사용자 이름을 입력합니다.
프록시 비밀번호: 사용자 비밀번호의 Secret Manager 보안 비밀을 선택합니다.
보안 비밀 버전: 보안 비밀 버전을 선택합니다.
프록시 서버 섹션에서 프록시 서버의 세부정보를 입력합니다.
1. + 대상 추가를 클릭한 후 대상 유형을 호스트 주소로 선택합니다.
2. 프록시 서버의 호스트 이름 또는 IP 주소와 프록시 서버의 포트 번호를 입력합니다.

연결 구성 샘플

기본 인증 연결 유형

필드 이름	세부정보
위치	us-east4
커넥터	Zendesk
커넥터 버전	1
연결 이름	CONNECTION_NAME
Cloud Logging 사용 설정	예
서비스 계정	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
호스트	HOST_ADDRESS
UserPassword	예
사용자 이름	USERNAME
비밀번호	PASSWORD
보안 비밀 버전	1

항목, 작업, 조치

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

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

시스템 제한사항

Zendesk 커넥터는 노드별로 초당 트랜잭션 5개를 처리할 수 있으며 이 한도를 초과하는 트랜잭션을 제한합니다. 기본적으로 Integration Connectors는 가용성을 높이기 위해 연결에 2개의 노드를 할당합니다.

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

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

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

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

작업

Zendesk 커넥터는 ticket ID를 기반으로 티켓을 관리하는 작업을 제공합니다. 작업을 구성하는 방법은 작업 예시를 참조하세요.

작업 예시

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

예시 - 티켓 삭제

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

이 예에서는 티켓을 영구적으로 삭제합니다. 작업이 성공하면 커넥터 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
  "Success": "true"
}]

참고: DeleteTicketsPermanently 작업은 레코드를 영구적으로 삭제합니다. 소프트 삭제를 수행하려면 항목 삭제 작업을 사용합니다.

예시 - 티켓 병합

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

이 예시에서는 두 티켓을 병합합니다. 작업이 성공하면 커넥터 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
  "Success": null,
  "Message": null
}]

예시 - 티켓 복원

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

이 예에서는 티켓을 복원합니다. 작업이 성공하면 커넥터 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
  "Success": "true"
}]

예시 - 정지된 티켓 복구

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

이 예시에서는 정지된 티켓을 복구합니다. 작업이 성공하면 커넥터 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
  "Id": "60921"
}]

항목 작업 예시

예시 - 모든 티켓 나열

이 예시에서는 Tickets 항목의 모든 티켓을 나열합니다.

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

예시 - 티켓 가져오기

이 예시에서는 Tickets 항목에서 ID가 35인 티켓을 가져옵니다.

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

예시 - 티켓 만들기

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

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

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

{
    "Subject": "Zendesk_Create_Ticket",
    "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 항목에서 ID가 35인 티켓을 업데이트합니다.

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

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

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

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

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

예시 - 티켓 삭제

이 예시에서는 Tickets 항목에서 ID가 35인 티켓을 삭제합니다.

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

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

terraform을 사용하여 연결 만들기

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

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

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

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

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

통합에서 Zendesk 연결 사용

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

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

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

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

다음 단계

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