Sunshine Conversations API를 사용하여 요청을 할 때에는 인증을 통해 발신자의 신원을 확인해야 합니다. 기본 인증 또는 JSON 웹 토큰(JWT)을 사용하여 발신자의 신원을 확인할 수 있습니다. 두 방법 모두 API 키가 필요합니다. 대화 API 페이지를 사용하여 API 키를 만듭니다.
Zendesk Suite Professional 플랜 이상에서 대화 API 페이지를 이용할 수 있습니다. 이 페이지를 보려면 Zendesk 상담사 워크스페이스가 활성화되어 있어야 합니다. 월간 활성 사용자(MAU) 또는 알림이 더 많이 필요한 경우 추가로 추가 기능 팩을 이용할 수 있습니다. 자세한 내용은 Zendesk Suite 추가 기능에 대한 정보를 참조하세요.
이 문서는 다음 섹션으로 구성되어 있습니다.
API 키에 대한 정보
API 키는 애플리케이션이나 사용자를 식별하고 인증하며 다음의 세 부분으로 구성됩니다.
- 앱 ID는 Zendesk 계정을 식별합니다.
- 비밀 키와 함께 사용되는 키 ID는 JWT 및 API 호출을 인증하는 데 사용되는 자격 증명입니다.
- 비밀 키는 인증 비밀번호입니다.
기본 인증에서는 직접 API 키를 사용하여 요청을 합니다. 키 ID는 사용자 이름이며 비밀키는 비밀번호입니다.
JWT에서는 API 키로 토큰에 서명하며 이 토큰이 API로 인증하는 데 사용됩니다. 키 ID는 kid 특성으로 JWT 머리글에 포함되며 비밀키는 JWT에 서명합니다.
API 키는 인증 토큰만큼 안전하지 않습니다. 프로덕션에서 API 키 사용 시 반드시 모범 관행에 따라 자격 증명을 안전하게 처리하도록 하세요.
Sunshine Conversations 인증에 대한 자세한 내용은 API 인증을 참조하세요.
Sunshine Conversations API 키는 메시징 인증 키와 다릅니다. 메시징 인증 키는 Zendesk SDK를 사용하는 최종 사용자를 인증하는 자격 증명에 서명하는 데 사용됩니다. 여기 설명된 API 키는 서버 간 호출을 위한 것이며 app 범주를 지원하는 Sunshine Conversations 공개 API에 대한 액세스를 제공합니다.
ID 및 API 키 만들기 및 공유하기
Zendesk 관리자가 API 키를 만들어 개발자와 공유해야 합니다. 최대 10개의 키를 보관할 수 있습니다.
API 키를 만들고 공유하려면 다음과 같이 하세요.
-
관리 센터의 사이드바에서
앱 및 연동 서비스를 클릭한 다음 API > 대화 API를 선택합니다.
참고: 이 창을 보려면 Zendesk Suite Professional 플랜 이상이 있어야 합니다. -
API 키 만들기를 클릭합니다.
처음 키를 만드는 경우에는 이 버튼이 페이지 맨 아래에 나타나고, 이전에 키를 만든 경우에는 오른쪽 위에 나타납니다.
- 새 키 만들기 대화 상자에 키를 식별하는 이름을 입력한 후 다음을 클릭합니다.
- 공유 비밀키 복사 대화 상자에서 각 ID와 비밀키에 대해 복사를 클릭하여 클립보드에 저장한 후 다음을 클릭합니다.
API 창에 돌아오면 목록에 새 키가 나타납니다.
새 키를 생성하지만 10개 키 제한에 도달한 경우에는 사용하지 않는 키를 삭제하라는 알림이 나타납니다.
사용하지 않는 키를 삭제하려면 다음과 같이 하세요.
- 관리 센터의 사이드바에서 앱 및 연동 서비스를 클릭한 다음 API > 대화 API를 선택합니다.
- 삭제하려는 키에 마우스 포인터를 갖다 댄 다음 옵션 메뉴(
)를 클릭하고 삭제를 선택합니다. - 삭제를 클릭하여 작업을 확인합니다.