봇과 상호작용하는 동안 고객에게 데이터를 가져오거나 푸시하고 이를 표시하기 위해 외부 시스템에 광범위한 API 호출을 할 수 있습니다. API 라이브러리에서 한 번 구성한 후, 해당 봇의 모든 대화에서 재사용할 수 있습니다.
목차
- 새 API 생성 빠른 가이드
- API 구성하기
- API 목록 페이지
- API 사용 빠른 가이드
새 API 생성 빠른 가이드
Chatbots로 이동 > 봇 선택 또는 새로 생성 > Flows > Configure > API 라이브러리.
참고: API의 cURL 세부정보 또는 Postman 컬렉션(버전 2 및 2.1 지원)이 있는 경우, Flows > Configure > API 라이브러리 > Import APIs로 이동하여 cURL 명령어 또는 Postman 컬렉션을 붙여넣고 API를 즉시 가져올 수 있습니다.
+Add new 버튼을 클릭하여 새 API 호출을 구성할 수 있습니다.
API 구성하기
- 이름: API 호출에 적절한 이름을 지정합니다.
- URL/JS 함수 이름: 엔드포인트 URL을 여기에 제공합니다. 이 필드의 콘텐츠 선택기 옵션 [+]를 사용하여 고객 입력, 다른 API 응답, 기본 매개변수 등을 플레이스홀더 값으로 추가할 수 있습니다.
- 메서드: 수행하려는 API 호출 유형을 구성합니다 - GET, PUT, POST, DELETE 또는 JS 함수, 그리고 이에 따라 페이로드를 전달합니다. 확장 가능한 텍스트 편집기에서 더 큰 페이로드 콘텐츠를 구성할 수도 있으며, 여기에 JSON을 붙여넣으면 자동으로 포맷됩니다. 예를 들어, Freshdesk 계정에서 티켓을 생성하려면 이메일, 우선순위, 상태, 주제 및 설명을 JSON으로 전달합니다. 오른쪽 하단의 + 아이콘을 사용하여 플레이스홀더를 사용할 수도 있습니다.
- 참고: POST 또는 PUT 메서드를 설정할 때, 페이로드 유형으로 JSON, Multipart form data 또는 URL 인코딩된 폼 중에서 선택할 수 있습니다. multipart forms에 대해 더 알아보기.
- 헤더 추가: 이 필드에서 API를 인증하고 추가 매개변수를 헤더로 전달할 수 있습니다.
- 테스트: API 호출이 올바르게 구성되었는지 확인하려면 Run Test 체크박스를 선택하고 페이로드에 구성한 동적 필드에 대한 테스트 값을 전달하여 샘플 테스트 실행을 수행하고 응답 헤더를 확인할 수 있습니다.
- 필요한 응답 매개변수 추가 또는 제거: 응답 헤더 또는 챗봇 대화 다이얼로그의 속성을 참조할 수 있습니다. 테스트 변수 응답에서 버튼 클릭으로 필요한 응답 매개변수를 추가하거나 제거할 수 있습니다.
API 목록 페이지
Flows > Configure > API 라이브러리에서 API 라이브러리에 액세스할 수 있습니다. 이 페이지에서 구성한 API 목록을 볼 수 있습니다. 이 외에도 이 페이지를 사용하여:
- 구성한 API 검색
- API의 작업(GET, POST 등) 보기
- API 생성 및 마지막 수정 날짜 표시
- 각 API 편집 또는 삭제, 새 API 생성
API 사용 빠른 가이드
메시지, 액션 또는 조건을 통해 API 응답을 추가할 수 있습니다.
메시지를 사용하여 API 응답 추가하기
- 고객에게 표시할 메시지나 질문을 입력합니다.
- 플레이스홀더에 액세스하려면 + 아이콘을 클릭 > APIs.
- 봇 빌더가 API 라이브러리에 구성된 모든 API 목록을 표시합니다.
- 필요한 API를 선택하여 텍스트 상자에 추가합니다.
예를 들어, 봇 대화에서 티켓을 생성하는 경우, 티켓 생성 API 호출을 설정할 수 있습니다. 그런 다음 응답 매개변수에서 티켓 ID를 참조할 수 있습니다.
액션에서
- 대화에서 새 액션 생성
- 액션 유형을 Trigger API로 설정
- 해당 봇의 API 라이브러리에 구성된 모든 API 중에서 필요한 API 선택
Trigger API 액션은 흐름 어디에나 삽입할 수 있습니다. 메시지 전에 API를 트리거해야 하는 경우, Trigger API 액션을 생성합니다. 마찬가지로, 메시지 후에 API를 트리거해야 하는 경우, Trigger API 액션을 생성합니다.
조건에서
- 필요한 대화의 조건 탭 열기 > + 아이콘을 클릭하여 플레이스홀더에 액세스 > 드롭다운에서 APIs 선택.
- API 라이브러리에 구성된 모든 API 목록을 볼 수 있습니다.
- 필요한 API 호출을 선택한 다음 응답 값을 선택합니다.
- API의 응답을 조건 본문과 조건 값 섹션 모두에서 사용할 수 있습니다.
예를 들어, 간단한 구독 흐름의 경우, API 응답에서 결제 상태를 가져와 상태가 미납인 경우 고객을 다른 대화/흐름으로 리디렉션하거나 상태가 결제 완료인 경우 고객에게 간단한 메시지를 표시하는 대화를 설정할 수 있습니다.
참고:
- JSON 응답이 있는 REST API만 지원됩니다.
- 응답을 받지 못한 경우 API 요청은 10초 후에 시간 초과됩니다.
- Postman 컬렉션의 경우, 최대 20개의 API와 파일 크기 <=20 KB를 허용합니다.