AI 상담사는 백엔드 시스템에 서버 간 HTTP 요청을 합니다. 사용자 경로가 대화에서 연동 노드를 트리거할 때 요청이 시작되고, 맵핑된 리턴된 데이터는 AI 상담사 세션 기간 동안 저장되어 사용 가능합니다.
백엔드 API의 기술적 요구 사항
API 유형
API는 다음 아키텍처 중 하나여야 합니다.
- REST
- GraphQL
응답
API 응답은 다음과 같은 일반 요구 사항을 따라야 합니다.
- 30초 이내에 API 응답 제공
- 가급적 JSON 형식을 리턴하세요.
인증
AI 상담사 측에서는 다음 중 하나를 사용하여 인증할 수 있습니다.
- API 키
- 무기명 토큰
- 만료 토큰
- 기본 인증
- OAuth 2.0
- IP 수신 허용 목록/허용 목록
셀프 체크리스트
아래의 셀프 체크리스트에는 강력한 API를 구축하는 데 도움이 되는 질문과 정보가 수록되어 있습니다.
- API가 일반 사용자가 알고 있는 데이터 또는 CRM 에서 전달된 데이터로 “검색 가능”합니까?
- API 응답의 데이터에 사용 사례를 충족하는 정보가 포함되어 있나요?
- 사용 사례에 여러 시스템의 데이터가 필요한 경우 이를 중간 계층에 통합할 수 있나요?
- API가 언제 200, 400 및 404 HTTP 상태 코드를 처리하는지 알 수 있나요?
- 입력이 올바르지 않거나 올바르지 않은 경우 API는 무엇을 리턴하나요?
- 시스템에서 API 호출 빈도 제한을 설정하나요?
- 시스템에서 응답을 보내는 데 얼마나 걸립니까?
다음을 제공할 준비를 하세요.
• 문서: 인증, API 요청 쿼리/본문 및 응답 스키마
• (선택 사항으로 Postman 컬렉션)
• 가장 일반적인 결과에 대한 데이터를 테스트합니다.
이전 문서인 사용자 지정 연동 서비스 - 준비에서 온보딩 플랜에 대해 자세히 알아보세요.
번역 고지 사항: 본 문서는 콘텐츠에 대한 기본적인 이해를 제공하기 위해 자동 번역 소프트웨어를 사용하여 번역되었습니다. 정확한 번역을 제공하고자 합당한 노력을 기울였으나 Zendesk는 번역의 정확성을 보장하지 않습니다.
번역된 문서에 포함된 정보의 정확성과 관련하여 질문이 있으시면 문서의 공식 버전인 영문 버전을 참조하시기 바랍니다.