연동 서비스 빌더는 확장된 기술 또는 프로그래밍 스킬 없이도 AI 상담사 모든 API 또는 데이터 소스에 연결할 수 있는 강력한 노코드 도구입니다. 동적 콘텐츠 로 채팅 경험을 개인화하고 더 높은 자동 해결을 유도하세요.
단 한 줄의 코드도 작성하지 않고도 백오피스 시스템에서 원활하게 고객 정보에 액세스하거나, 다른 외부 데이터 소스에서 데이터를 검색하거나, 타사 애플리케이션과 상호작용할 수 있는 AI 상담사 상상해 보세요.
동적 콘텐츠 기능으로 연동 서비스 빌더를 통해 실시간 데이터 검색, 분석 및 변환이 가능하여 AI 상담사 개별 사용자의 필요에 따라 맞춤 응답, 추천 및 솔루션을 제공할 수 있습니다.
사용자 친화적인 인터페이스, 직관적인 기능 및 코드 없는 기능을 갖춘 연동 서비스 빌더는 광범위한 기술 지식 없이도 완전한 유연성과 사용자 지정 기능을 제공합니다.
이 문서에서는 AI 상담사 API 또는 데이터 소스에 연결하기 위해 기능을 활용하는 방법에 대한 단계별 가이드와 함께 연동 서비스 빌더의 주요 기능 및 이점을 살펴봅니다.
시작하기
연동 빌더에 액세스하려면 사이드 탐색 메뉴에서 “API 연동”을 클릭하기만 하면 됩니다. 그러면 향후의 모든 연동 서비스가 편리하게 나열되고 액세스할 수 있는 개요 목록으로 이동합니다. 처음에는 온보딩 여정에 따라 API 연동을 사용하지 않거나 예제 API 연동으로 시작합니다.
새 연동 서비스를 만들려면 오른쪽 위에 있는 " 연동 서비스 추가"를 클릭합니다.
연동 서비스의 이름을 제공합니다.
추가적인 전후상황과 함께 짧은 설명을 추가합니다.
완료되면 “저장”을 클릭하여 연동 서비스 구성 페이지로 이동합니다.
사이드 탐색에 API 연동 서비스가 보이지 않는다면 클라이언트 관리자가 아닐 가능성이 높습니다. 현재 클라이언트 관리자만 연동 빌더에 액세스할 수 있도록 제한합니다. 이 경우에는 해당 CSM에 문의하여 액세스 권한에 대해 논의하세요.
동영상 및 오디오 입력을 통한 학습을 선호하는 경우를 위해 맞춤 엔지니어링 팀인 Chloe의 소개 동영상이 아래에 있습니다.
요청 매개변수
시작하려면 API의 성공적인 응답을 보장하기 위해 필요한 요청 매개변수를 구성해야 합니다. 이러한 요청 매개변수는 대화에서 파생된 정보를 포함하며 API 요청의 세부 사항을 정의하는 역할을 합니다. 예를 들어 대화 중 표시할 특정 사용자 정보를 검색하려는 경우 사용자 ID를 요청의 일부로 포함하는 것이 중요해집니다. 이로써 API 응답에 채팅에 참여한 현재 사용자나 방문자와 관련된 데이터가 포함됩니다.
다음은 구성된 요청 매개변수의 예입니다.
키 및 요청 매개변수 유형을 지정하는 것 외에도 테스트 값을 설정할 수 있는 옵션이 있습니다. 구성 중 오른쪽 위에 있는 테스트 기능을 활용할 때 이 테스트 값이 사용되므로 그렇게 하는 것이 좋습니다. 실제 실시간 대화 중 요청을 하기 전에 값이 API 연동 서비스에 전달됩니다. 하지만 현재 실시간 대화의 컨텍스트가 없으므로 API 호출을 성공적으로 수행하려면 테스트 값을 설정해야 합니다.
“필수” 확인란을 사용하면 요청 매개변수가 선택 사항인지 또는 세션에 아직 저장되지 않은 경우 대화에서 API 연동 서비스를 호출하기 전에 요청 매개변수를 수집해야 하는지 여부를 결정할 수 있습니다.
요청 매개변수의 포함 여부는 호출되는 API의 특정 요구 사항에 따라 다릅니다. 일부 API의 경우 요청 매개변수가 URL에 첨부되는 반면, 다른 API의 경우 요청의 헤더나 본문에 포함됩니다. API 문서를 참조하여 요청 매개변수를 포함해야 하는 위치를 결정하세요. 식별된 후에는 이중 중괄호로 묶인 키를 참조하여 URL, 헤더 또는 본문에 요청 매개변수를 추가할 수 있습니다.{{userID}} .
환경
요청 매개변수가 추가된 후에는 환경 섹션 내에서 API 호출에 대한 기본 설정을 수행할 수 있습니다. 연동 테스트 중 또는 대화 빌더에서 참조할 때 나타나는 환경 이름에 인접하여 기본 API 문서에 따라 방법, URL 및 권한 부여 유형을 선택해야 합니다.
권한 부여 유형
Zendesk는 다음과 같은 권한 부여 유형을 제공합니다.
| 권한 부여 유형 | 설명 | 예 |
| API 키 | API 소유자가 제공해야 하는 간단한 API 키입니다. |  |
| 무기명 토큰 | API 소유자가 제공해야 하는 또 다른 토큰입니다. |  |
| 기본 인증 | 사용자 이름과 비밀번호는 API로 인증하는 데 사용됩니다. |  |
| OAuth 2.0 | 권한 부여 유형에 따라 여러 인증 정보가 필요합니다. |  |
| 사용자 지정 | 만료 토큰을 통한 권한 부여 | 연동 빌더로 사용자 지정 권한 부여 사용하기를 참조하세요. |
인증 토큰을 다음으로 추가하여 요청에 포함해야 합니다.{{apiToken}} 모든 권한 부여 유형의 헤더에 추가합니다(권한 부여 없음 제외). 헤더 섹션의 예를 살펴보세요.
헤더
헤더에는 요청 또는 클라이언트와 서버가 서로 통신하는 데 대한 추가 정보가 포함됩니다. 요청의 헤더 섹션에 포함된 키-값 쌍입니다. 일반적으로 사용되는 몇 가지 헤더는 다음과 같습니다.
- Content-Type: 요청 본문의 데이터 형식(예: JSON, XML, 양식 데이터)을 나타냅니다.
- 권한 부여: 요청을 하는 클라이언트를 인증하기 위한 자격 증명이나 토큰을 제공합니다.
- 사용자-에이전트: 요청을 시작하는 사용자 에이전트(일반적으로 웹 브라우저나 클라이언트 애플리케이션)를 지정합니다.
- 수락: 클라이언트가 허용하는 응답 형식에 대해 서버에 알립니다.
- Cache-Control: 서버 또는 중간 캐시에 대한 캐싱 지시문을 정의합니다.
- X-Requested-With: 클라이언트의 요청 유형(예: XMLHttpRequest, Fetch API)을 식별합니다.
본문
API 요청의 본문에는 API로 보낸 데이터가 포함됩니다. 일반적으로 API 측에서 처리 또는 데이터 처리를 위해 입력 데이터가 필요한 요청에 사용됩니다. 본문은 API 및 호출되는 특정 엔드포인트에 따라 JSON, XML, 일반 텍스트 또는 양식 데이터와 같은 다양한 형식을 포함할 수 있습니다. 이 경우에는 지금까지 JSON만 지원합니다.
환경 관리하기
API용 샌드박스 및 프로덕션 환경을 처리하는 문제를 해결하기 위해 환경의 개념을 연동 빌더에 통합했습니다. 연동 서비스를 설정할 때 자동으로 만들어지는 기본 기본 환경 외에 추가 환경을 포함할 수 있는 유연성이 있습니다.
이러한 추가 환경을 통해 URL, 인증 세부 정보, 헤더 및 요청 본문을 사용자 지정할 수 있어 API 내에서 특정 샌드박스 또는 프로덕션 환경을 대상으로 지정할 수 있습니다.
새 환경을 만들려면 환경 섹션 옆에 있는 "+" 버튼을 클릭하면 됩니다. 기존 환경을 복제하려면 해당 환경에 커서를 갖다 대고 점 3개로 된 메뉴에서 "복제" 옵션을 선택합니다. 하나의 환경만 기본으로 설정할 수 있으며, 이 환경은 목록 맨 위에 배치되고 대화 빌더에서 자동으로 첫 번째로 선택됩니다(의도적으로 수정하지 않는 한).
AI 상담사가 사용하고 있지 않은 환경이 단독 환경이거나 기본 환경인 경우에는 삭제할 수 있습니다. 기본 설정을 수정하려면 점 3개로 된 메뉴에서 적절한 옵션을 쉽게 선택할 수 있습니다.
기능 테스트
API 요청의 설정을 완료한 후에는 모든 구성이 올바르게 완료되었는지 확인하는 것이 좋습니다. 이 프로세스를 용이하게 하기 위해 연동 빌더는 오른쪽 위에 있는 편리한 테스트 기능을 제공합니다.
테스트 버튼은 기본 환경의 이름 뒤에 오는 "테스트" 레이블로 쉽게 식별할 수 있습니다. 클릭하면 연동 빌더가 요청 매개변수 및 환경 섹션에서 제공된 정보를 사용하여 API에 대한 요청을 시작합니다. API에서 받은 응답은 인터페이스 오른쪽의 연동 테스트 섹션에 표시됩니다. 다른 환경의 요청 세부 정보를 사용하여 API를 테스트하려면 테스트 기능 내의 드롭다운 메뉴에서 원하는 환경을 선택하고 테스트 버튼을 다시 클릭하면 됩니다.
응답 콘텐츠
연동 테스트 섹션 내에서 연동 빌더는 API에서 얻은 응답을 제시합니다. 응답의 콘텐츠는 다음과 같은 개체로 구성됩니다.
| 개체 | 콘텐츠 | 예 |
| statusCode | HTTP 응답 상태 코드는 특정 HTTP 요청이 성공적으로 완료되었는지 여부를 나타냅니다. 자세히 알아보기 | "statusCode" : 200 |
| data | 데이터 개체는 요청 성공 시 API의 관련 데이터를 보여줍니다. 하지만 요청이 실패하면 해당 상태 코드에 따라 추가 정보를 제공합니다. |
"data" : { "name" : "독일" , "capital" : "베를린" , "region" : "유럽" , "population" : 83240525 , "area" : 357114 } |
| requestParameters | requestParameters 개체 내에서 연동 빌더는 API를 호출하는 데 사용된 관련 테스트 값과 함께 요청 매개변수를 표시합니다. |
"requestParameters" : { "country" : "de" } |
테스트 기능을 다시 활용하여 수정된 구성이 있는 연동 서비스를 검사하기 전에 반드시 연동 서비스를 저장하세요.
시나리오
새로 만든 각 연동 서비스에는 미리 구성된 3가지 시나리오가 포함되어 있습니다. 이러한 시나리오 중 두 가지를 필요에 따라 사용자 지정하거나 삭제할 수 있지만 “대체”라는 세 번째 시나리오는 편집할 수 없습니다. 이 “대체” 시나리오는 이전 시나리오 중 어느 것도 트리거되지 않는 경우 기본 대체 옵션으로 작동합니다.
| 시나리오 | 기본 쿼리 | 설명 |
| 성공 | statusCode> = 200 및 statusCode< 300 | statusCode가 200과 300 사이인 경우 기본/행복 경로를 캡처해야 하는 시나리오입니다. |
| 실패 | statusCode< 200 또는 statusCode> = 300 | statusCode가 2XX를 벗어나는 경우 실패한 경로를 캡처해야 하는 시나리오입니다. |
| 대체 | - | 대체 시나리오를 선택하여 항상 하나 이상의 시나리오를 트리거합니다. |
시나리오는 API 연동이 트리거될 때 대화에서 대화가 따르는 다른 브랜치와 동일합니다.
시나리오 쿼리
각 API 연동에 대해 하나의 시나리오만 트리거될 수 있습니다. 대화 중 어느 시나리오가 트리거되는지 결정하는 논리는 시나리오 쿼리 및 시나리오가 정의된 순서에 따라 다릅니다.
시나리오 쿼리는 특정 시나리오를 트리거하기 위해 충족되어야 하는 조건을 나타냅니다. 조건이 true인지 확인하기 위해 연동 빌더는 API 응답에 포함된 데이터는 물론 시나리오 쿼리를 검사합니다. 일반적으로 사용되는 데이터 필드에는 statusCode, API 응답의 데이터 개체 내의 API 관련 데이터 및 요청 매개변수의 값이 포함됩니다.
성공 시나리오의 기본 시나리오 쿼리를 사용하려면 API 응답의 statusCode가 200~300 범위 내에 있어야 합니다. 이 조건이 충족되면 성공 시나리오가 트리거됩니다.
기본 시나리오 쿼리를 수정하고 새 시나리오를 추가할 수 있으므로 API 응답에 따라 서로 다른 시나리오의 여러 시나리오 쿼리가 참일 수 있습니다. 그러한 경우 시나리오 순서에 따라 트리거될 시나리오가 결정됩니다.
시각적 피드백을 제공하기 위해 현재 API 응답에 따라 어느 시나리오가 트리거되는지 나타내는 기능을 구현했습니다. 또한 이론적으로는 트리거될 수 있지만 고차 시나리오가 트리거되어 실제로 트리거되지 않는 시나리오를 식별합니다. 또한 조건이 충족되지 않아 트리거되지 않는 시나리오를 강조 표시합니다.
| 기준 일치 | 시각화 | 설명 |
| 기준이 순서대로 먼저 일치 |  |
파란색 점선으로 강조 표시된 시나리오는 트리거될 시나리오를 나타냅니다. |
| 기준이 일치하지 않음 |  |
빈 점으로 강조 표시된 시나리오는 트리거되지 않습니다. |
| 기준이 일치하지만 첫 번째 순서가 아님 |  |
회색 점으로 표시된 시나리오는 이론적으로만 트리거됩니다. |
시나리오 순서를 수정하려면 시나리오를 클릭하고 드래그하여 순서를 다시 정렬하면 됩니다. 항상 마지막 위치에 남아 있는 대체 시나리오를 제외하고 기본 설정에 따라 순서를 조정할 수 있습니다.
세션 매개변수
각 시나리오를 구성할 때 백엔드 시스템의 다양한 데이터 포인트로 대화를 개선할 수 있습니다. API 응답의 관련 정보를 세션 매개변수로 변환하고 저장하여 각 시나리오에 액세스할 원하는 데이터를 지정할 수 있습니다. 그런 다음 이러한 세션 매개변수를 대화 구축 프로세스에서 활용하여 방문자에게 정보를 제시하거나 기본 워크플로우를 계획할 수 있습니다.
세션 매개변수는 키-값 쌍으로 정의됩니다. 키는 대화 빌더 내에서 참조 역할을 하는 반면, 쿼리는 API 응답에서 특정 데이터를 변환하고 추출하여 값을 저장하는 데 사용됩니다. 연동 빌더는 현재 응답을 기준으로 저장된 값이 응답 값 필드에 어떻게 표시되는지에 대한 실시간 피드백을 제공합니다.
위의 이미지에서 세션 매개변수 키는 “capital”로 정의되며 중괄호를 사용하여 대화 빌더 내에서 참조될 수 있습니다.{{capital}} . 쿼리는 세션 매개변수의 값으로 변환되어 저장되어야 하는 데이터를 결정합니다. 이 경우에는 API 응답의 데이터 개체 내에 있는 “capital” 필드에서 콘텐츠를 추출합니다.
쿼리 언어 - JSONata
JSONata는 시나리오 수준 쿼리와 세션 매개변수 수준 쿼리 둘 다에 대한 쿼리 언어로 사용됩니다. 간단한 쿼리는 작성하기 쉬워야 한다는 원칙에 따라 설계되어 기술에 정통한 전문가와 그렇지 않은 전문가 모두 액세스할 수 있습니다. JSONata는 학습 곡선이 단순하여 신속하게 마스터할 수 있습니다. JSONata를 사용하면 기본 함수를 실행하고, 날짜를 변환하며, 서로 다른 데이터 포인트를 병합할 수도 있습니다.
JSONata는 공개적으로 문서화된 쿼리 및 변환 언어로 여기에서 문서를 찾을 수 있습니다.
번역 고지 사항: 본 문서는 콘텐츠에 대한 기본적인 이해를 제공하기 위해 자동 번역 소프트웨어를 사용하여 번역되었습니다. 정확한 번역을 제공하고자 합당한 노력을 기울였으나 Zendesk는 번역의 정확성을 보장하지 않습니다.
번역된 문서에 포함된 정보의 정확성과 관련하여 질문이 있으시면 문서의 공식 버전인 영문 버전을 참조하시기 바랍니다.