Docs

Docs

화면 사용법과 연동 규격을 정리한 매뉴얼입니다.

API 연동

버전 정책과 제한

호환성 보장 범위와 아직 제공하지 않는 기능입니다.

버전 정책#

주소에 버전(/api/v1)이 들어가며 현재는 v1 하나입니다.

v1에서 바뀌지 않는 것예고 없이 추가될 수 있는 것
기존 응답 필드의 삭제·이름·타입응답의 새 필드
기존 허용 값의 삭제·의미허용 값(enum)의 새 값
기존 에러의 HTTP 상태 코드새 에러 코드
엔드포인트 주소와 메서드새 엔드포인트

파트너에게 꼭 전할 것

응답을 너무 엄격하게 검사하지 않도록 안내하세요. 모르는 필드나 새 enum 값에서 오류를 내면, 값이 추가되는 순간 연동이 깨집니다. 모르는 값은 원문 그대로 저장·표시하는 것이 안전합니다.

제공하지 않는 기능#

항목현재 상태
결과 푸시(웹훅)없음. 파트너가 조회로 가져감
담당자 지정·조회API로 불가. 응답에도 담당자 정보 없음
파일 업로드없음. 이미지는 파트너 쪽 주소를 본문에 넣음
중복 방지 키(멱등키)없음. 접수 중복 방지는 파트너가 처리
호출 횟수 제한현재 없음. 조회 주기 1분 이상 권장
키 만료·자동 갱신없음. 폐기 후 새로 발급
확정 취소 API없음. 답변 수정·삭제로 대신
포털 토큰·세션 수명 조정, 토큰 취소불가. 2분 · 30분 · 2시간 고정
포털 답변 전달없음. 고객이 팝업의 접수 내역에서 확인