Docs

Docs

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

API 연동

REST 빠른 시작

API 키 발급부터 첫 이슈 접수, 결과 조회까지 5분 안에 따라 해봅니다.

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

API 키를 발급하고, 이슈 하나를 접수한 뒤, 담당자 답변을 조회로 받아오는 전체 흐름을 따라 합니다. 아래 예시는 Next.js 기준이고, 탭에서 cURL·Python·Java로 바꿔볼 수 있습니다. 명령어 없이 API 테스트 콘솔에서 버튼으로 해도 됩니다.

테스트용 프로젝트에서 하세요

여기서 만든 이슈는 실제 이슈로 쌓입니다. 운영 프로젝트라면 끝난 뒤 이슈를 삭제하세요.

1. API 키 발급#

프로젝트 설정의 API 키 탭에서 프로젝트를 고르고 발급처 이름을 넣어 발급합니다. 화면에 한 번만 보이는 sk_live_... 키를 복사해 둡니다.

프로젝트 설정 - API 키

2. 키 확인#

모든 요청에는 X-API-Key 헤더가 필요합니다. 키가 맞으면 연결된 프로젝트 이름이 돌아옵니다.

const res = await fetch("https://<도메인>/api/v1/ping", {
  method: "GET",
  headers: { "X-API-Key": process.env.CS_API_KEY! },
});
const data = await res.json();
응답 200
{ "success": true, "item": { "keyName": "쇼핑몰A", "projectId": "0192...", "projectName": "쇼핑몰A CS" } }

3. 이슈 접수#

const res = await fetch("https://<도메인>/api/v1/issues", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.CS_API_KEY!,
    "Content-Type": "application/json; charset=utf-8",
  },
  body: JSON.stringify({
    "title": "결제가 안 됩니다",
    "requesterName": "홍길동",
    "requesterEmail": "hong@example.com"
  }),
});
const data = await res.json();
응답 201
{ "success": true, "item": { "id": "01920000-0000-7000-8000-00000000000a", "issueNum": 42 } }

돌아온 id를 저장합니다. 파트너 시스템에서는 이 값을 자기 문의 번호와 짝지어 보관해야 합니다. 이제 이 앱의 이슈 목록에서 새 이슈가 보입니다.

4. 답변 확정 (이 앱에서)#

이슈 상세에서 댓글로 답변을 쓰고 확정합니다. 이슈가 완료로 바뀝니다.

5. 결과 조회#

const res = await fetch("https://<도메인>/api/v1/issues?updatedFrom=2026-01-01T00:00:00.000Z", {
  method: "GET",
  headers: { "X-API-Key": process.env.CS_API_KEY! },
});
const data = await res.json();

응답의 items[].confirmedComment에 방금 확정한 답변이 들어 있습니다. 이 순간 답변은 전달 완료로 처리되고, 동기화 현황의 완료 탭으로 옮겨갑니다.

다음 단계