Docs

Docs

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

API 연동

연동 방식 소개

REST API 와 포털 팝업, 두 가지 연동 방식을 비교하고 무엇을 고를지 안내합니다.

두 가지 연동 방식#

외부 서비스(파트너)가 고객 문의를 이 시스템에 넣는 방법은 두 가지입니다. 둘 다 프로젝트에 발급한 API 키 하나로 시작합니다.

REST API포털 팝업
한 줄 요약파트너 서버가 문의를 대신 넘기고 답변을 가져감고객이 우리 화면(팝업)에 직접 작성
문의 작성 화면파트너가 직접 만듦우리가 제공 (로고·색상 설정 가능)
답변 확인파트너가 조회 API로 가져가 고객에게 안내고객이 팝업의 접수 내역에서 직접 확인
파트너 개발량많음 (폼, 조회 작업, 결과 반영)적음 (토큰 발급 + 팝업 열기)
유입 경로 표시파트너가 지정 (기본 자체)항상 외부 서비스

무엇을 고를까#

  • 파트너가 이미 자체 문의 게시판·앱이 있고 답변도 그 안에서 보여줘야 한다 → REST API
  • 문의 기능을 빨리 붙이고 싶고 화면을 따로 만들 여력이 없다 → 포털 팝업

한 파트너가 두 방식을 함께 써도 됩니다. 같은 키로 둘 다 호출할 수 있습니다.

REST API 흐름#

이슈 접수
POST /issues
담당자 처리
이 앱에서 배정·답변·확정
변경분 조회
GET /issues 주기 호출
고객 안내
파트너 시스템에 반영

이 시스템은 파트너에게 먼저 요청을 보내지 않습니다(웹훅 없음). 파트너가 주기적으로 조회해 가져가는 방식입니다. 이유와 방법은 결과 동기화에 있습니다.

포털 팝업 흐름#

토큰 발급
파트너 서버 → POST /launch-tokens
팝업 열기
받은 URL을 새 창으로
고객 작성
우리 화면에서 제출
결과 수신
팝업이 부모 창에 접수 내용 전달

파트너에게 줄 문서#

이 가이드는 내부 직원용 요약입니다. 파트너에게는 같은 내용을 더 자세히 담은 연동 문서(REST 가이드·레퍼런스, 포털 가이드·레퍼런스, OpenAPI 스펙)가 따로 있으니 개발 담당자에게 요청해 전달하세요.

직접 해보기

빠른 시작을 따라 하면 키 발급부터 첫 조회까지 5분이면 확인할 수 있습니다.