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