봇 빌더 및 자동 지원 작업에 대한 API 연결 만들기

빠른 보기: 관리 센터 > 앱 및 연동 서비스 > 연결 > 연결

이 기능은 AI 상담사의 일부입니다.

연결을 통해 Slack 또는 Shopify 등의 서비스나 시스템에 대한 API 자격 증명을 안전하게 저장할 수 있습니다. 연결을 사용하여 봇 빌더의 API 호출하기 단계에서 REST API 호출을 인증하거나 자동 지원 작업을 수행할 수 있습니다. 연결을 만들려면 관리자여야 합니다.

이 문서에서 다루는 주제는 다음과 같습니다.

연결에 대한 정보
연결 만들기
허용되는 도메인
API 키에 대한 HTTP 헤더

연결에 대한 정보

연결은 다음 API 인증 방법 중 하나를 지원합니다.

API 키
기본 인증
무기명 토큰
OAuth 2.0

이 인증 방법은 연결이 저장하는 자격 증명의 유형을 결정합니다. 예를 들어 기본 인증 연결은 사용자 이름과 비밀번호를 저장합니다. 연결을 만든 후에는 인증 유형을 변경할 수 없습니다.

API별로 서로 다른 인증 방법을 지원합니다. API 호출의 적합한 인증 방법을 결정하려면 API 문서를 참조하세요.

인증 유형에 대한 HTTP 헤더

연결을 사용하여 봇 빌더에서 API 호출을 인증할 때에는 Zendesk가 HTTP 헤더에 연결의 자격 증명을 전달합니다. Zendesk는 연결의 인증 유형에 기반하여 이 헤더를 결정합니다.

인증 유형	HTTP 헤더
API 키	연결을 만들 때 설정합니다. API 키의 HTTP 헤더를 참조하세요.
기본 인증	`Authorization: Basic`
무기명 토큰	`Authorization: Bearer`
OAuth 2.0	`Authorization: Bearer`에서 서비스에 액세스 토큰을 보냅니다.

봇에서 연결을 사용하는 데 대한 자세한 내용은 봇 빌더에서 API 호출하기 단계 사용하기를 참조하세요. 작업에서 연결을 사용하는 데 대한 자세한 내용은 자동 지원용 작업 만들기 및 관리하기를 참조하세요.

OAuth 클라이언트 만들기

OAuth 연결은 Slack, Shopify 또는 Zendesk와 같은 서비스나 시스템에 대한 OAuth 2.0 액세스 토큰을 저장합니다.

OAuth 2.0 인증 유형으로 연결을 만들기 전에 OAuth 클라이언트를 구성해야 합니다. OAuth 클라이언트를 구성할 때 외부 시스템의 OAuth 구성 인터페이스나 관리자 포털에서 클라이언트 ID, 클라이언트 비밀키, 인증 URL, 토큰 URL 및 범위가 필요합니다. 이러한 자격 증명은 외부 시스템과의 클라이언트 애플리케이션(예: Zendesk)을 등록하는 동안 생성됩니다. 정확한 단계는 외부 서비스에 따라 다릅니다. 필요하면 클라이언트의 콜백 URL을 "https://zis.zendesk.com/api/services/zis/connections/oauth/callback"으로 설정합니다.

참고: OAuth 2.0 권한 부여 프레임워크와 호환되는 외부 시스템과의 연결만 지원합니다.

다음의 OAuth 2.0 권한 부여 유형을 사용하여 OAuth 클라이언트를 만들 수 있습니다.

인증 코드
클라이언트 자격 증명

인증 코드 권한 부여 유형을 사용하여 만든 OAuth 2.0 클라이언트에 대해 새로 고침 토큰 권한 부여 유형이 지원됩니다. 시스템의 액세스 토큰 응답이 비어 있지 않은 expires_in 및 refresh_token 값을 포함하는 경우에는 새로 고침 토큰을 사용하여 액세스 토큰이 자동으로 새로 고쳐집니다.

클라이언트 자격 증명 권한 부여 유형을 사용하여 클라이언트로 만든 OAuth 2.0 연결에는 토근 만료 값이 포함될 수 있습니다. 이런 경우에는 토큰이 만료할 때 동일한 OAuth 클라이언트를 사용하여 새 액세스 토큰을 가져옵니다.

참고: 경우에 따라 단일 새로 고침 토큰으로 액세스 토큰을 여러 번 새로 고쳐야 할 수도 있습니다. 일부 시스템은 새로 고침 토큰의 재사용을 방지하는 메커니즘을 구현하므로 가능한 경우 유예 기간을 구현하거나 대신 클라이언트 자격 증명 권한 부여 유형을 사용하는 것이 좋습니다.

OAuth 클라이언트를 만들려면 다음과 같이 하세요.

관리 센터의 사이드바에서 앱 및 연동 서비스를 클릭한 다음 연결 > 연결을 선택합니다.
클라이언트 이름을 입력합니다. 클라이언트를 만든 후에는 이 이름을 변경할 수 없습니다.
클라이언트 ID를 입력합니다. 클라이언트의 사용자 이름과 유사하게 OAuth 클라이언트에 배정된 고유 식별자입니다.
클라이언트 비밀키를 입력합니다. 클라이언트 애플리케이션의 비밀번호 역할을 하며 Zendesk와 외부 시스템 간의 신뢰를 구축합니다.
(인증 코드 권한 부여 유형만 해당) 인증 URL을 입력합니다. 인증 코드를 받는 데 사용되는 서버 URL입니다.
토큰 URL을 입력합니다. 액세스 토큰을 받는 데 사용되는 URL입니다.
띄어쓰기로 구분된 기본 범위 목록을 입력합니다. 범위는 클라이언트 애플리케이션이 사용자 대신 액세스할 수 있는 항목을 나타내는 권한입니다.
저장을 클릭하여 클라이언트를 만듭니다.

연결 만들기

관리 센터의 연결 페이지에서 연결을 만들 수 있습니다.

연결을 만들려면 다음과 같이 하세요.

관리 센터의 사이드바에서 앱 및 연동 서비스를 클릭한 다음 연결 > OAuth 클라이언트를 선택합니다.
연결 만들기를 클릭합니다.
인증 유형을 선택합니다.
연결의 이름을 입력합니다. 연결을 만든 후에는 이 이름을 변경할 수 없습니다.
다음 중 하나를 수행합니다.
- (API 키, 기본 인증, 무기명 토큰) 연결의 인증 자격 증명을 구성합니다. 연결은 이러한 세부 정보를 사용하여 서비스나 시스템에 대한 REST API 호출을 인증합니다.
- (OAuth 2.0) 사용할 클라이언트를 선택하고 선택 사항인 띄어쓰기로 구분된 범위 목록을 입력합니다. 범위를 입력하지 않으면 OAuth 클라이언트에서 지정된 기본 범위가 사용됩니다.
연결의 허용되는 도메인을 입력합니다. 연결을 만든 후에는 허용되는 도메인을 변경할 수 없습니다. 자세한 내용은 허용되는 도메인을 참조하세요.
저장을 클릭하여 연결을 만듭니다.

연결을 만든 후에는 관리 센터의 연결 페이지에서 세부 정보를 볼 수 있습니다. 연결 관리하기를 참조하세요.

참고: OAuth 2.0 인증 유형으로 연결을 만들 때에는 연결을 만들 때 정의된 범위가 아닌 외부 시스템의 액세스 토큰 응답에 포함된 범위가 저장됩니다. 이 값은 255자 이하여야 합니다.

허용되는 도메인

각 연결에는 허용되는 도메인으로 URL 호스트 이름이 필요합니다. Zendesk는 이 호스트 이름에 대한 API 호출의 연결 자격 증명만 전달합니다. 다른 호스트 이름과의 연결을 사용하려는 시도는 실패합니다. 이로써 연결의 자격 증명이 실수로 유출되는 것을 방지할 수 있습니다. 연결을 만든 후에는 허용되는 도메인을 변경할 수 없습니다.

예를 들어 허용되는 도메인 "api.example.com"과의 연결만 사용하여 “https://api.example.com” 호스트 이름에 API 호출을 할 수 있습니다.

허용되는 도메인 요구 사항

연결의 허용되는 도메인은 128자를 초과할 수 없습니다. 값의 하위 도메인이나 도메인은 63자를 초과할 수 없습니다. 값은 유효한 도메인 이름을 포함해야 합니다.

연결은 항상 https 스키마를 사용합니다. ftps 등의 다른 스키마는 지원되지 않습니다.

허용되는 도메인에 대한 와일드카드

연결의 허용되는 도메인은 선택 사항인 와일드카드(*) 하위 도메인을 지원합니다. 이로써 베어 도메인 및 모든 하위 도메인과의 연결을 사용할 수 있습니다. 예를 들어 허용되는 도메인 *.example.com과의 연결을 사용하여 "example.com" 또는 "example.com"의 하위 도메인에 대한 API 호출을 인증할 수 있습니다.

와일드카드 하위 도메인을 사용하려면 허용되는 도메인의 처음 두 문자가 *.여야 합니다. 호스트 이름의 다른 부분에서는 와일드카드를 사용할 수 없습니다. 예를 들어 호스트 이름 내에 exam*.com 또는 my-*.example.com. 등의 와일드카드를 사용할 수 없습니다.

*.com, *.com.au 또는 *.myshopify.com 등의 공개 도메인 접미어만 있는 와일드카드는 사용할 수 없습니다. 공개 접미어 목록은 publicsuffix.org에서 공개 접미어 목록을 참조하세요.

API 키에 대한 HTTP 헤더

API 키 연결을 만들 때 HTTP 헤더 이름을 지정해야 합니다. 연결을 사용하여 API 호출을 하면 Zendesk가 이 헤더에 대한 값으로 API 키를 전달합니다.

많은 API가 사용자 지정 헤더를 사용하여 API 키를 수락합니다. API 호출에 적합한 헤더 이름을 결정하려면 API 문서를 참조하세요.

헤더 이름 요구 사항

API 키 연결의 헤더 이름은 128자를 초과할 수 없습니다. 헤더 이름은 문자, 하이픈(-), 밑줄(_)만 포함할 수 있습니다.

다음 HTTP 헤더 이름은 사용할 수 없습니다.

accept
accept-charset
accept-encoding
accept-language
cache-control
connection
content-md5
cookie
date
expect
from
host
if-match
if-modified-since
if-none-match
if-range
if-unmodified-since
max-forwards
pragma
proxy-authenticate
proxy-authorization
range
server
referer
te
trailer
transfer-encoding
upgrade
user-agent
via
warning
www-authenticate
다음으로 시작하는 헤더 이름:
- x-amz-
- x-amzn-
- x-forwarded-
- x-zis-