개발자 리소스

승인된 고객 업무 한 가지를 선택하고 인증, 작업 공간, 권한, 재시도, 오류 처리, 감사 기록을 정한 뒤 API로 연결합니다.

하나의 요청에서 추적 가능한 결과까지.연동 설계 예시이며 실제 고객 시스템에 연결하지 않습니다.

실패는 성공과 구분합니다.

원래 요청과 실패 원인을 보존해 담당자에게 전달합니다. 시간 초과를 업무 완료로 처리하지 않습니다.

계약 명세 예제와 구현 맥락

연동 규약 예시

POST/cases

승인된 도입 범위에 따라 요청 출처, 인증 정보, 처리 방식, 데이터 저장 지역, 사용할 이벤트가 정해집니다.

연동 구현 체크리스트

다음 시스템을 연결하기 전에 고객 업무 한 가지가 성공·실패할 때의 처리 결과를 먼저 확인하세요.

승인된 도입 범위에 따라 요청 출처, 인증 정보, 처리 방식, 데이터 저장 지역, 사용할 이벤트가 정해집니다.

GET /knowledge/facts
Authorization: Bearer <server-token>
X-Workspace-Id: <workspace-id>

HTTP 200
X-Request-Id: req_...

{ "items": [], "nextCursor": null }

상태의미고객사 시스템 처리

401인증 정보가 없거나 만료되었거나 올바르지 않음요청을 중지하고 승인된 서버 절차로 인증 정보를 갱신합니다.

403요청한 작업에 필요한 권한 또는 범위가 없음다시 시도하지 말고 접근 권한 검토를 요청합니다.

409상태, 버전, 중복 처리 방지 키, 승인 상태가 충돌함충돌 내용을 확인하고 상태를 맞춘 뒤 다음 요청을 보냅니다.

422요청 형식이 공개된 스키마와 일치하지 않음오류에 표시된 필드를 수정한 뒤 다시 요청합니다.

429짧은 시간에 요청을 너무 많이 보냄응답에 안내된 대기 시간에 맞춰 요청 간격을 늘립니다.

5xx일시적인 서비스 오류가 발생했을 수 있음요청 ID를 보관하고 해당 작업이 재시도를 허용할 때만 다시 시도합니다.

인증 정보, 고객 비밀정보, 원본 결제 정보는 보내지 마세요. API 버전, 실행 환경, 호출 작업, 발생 시간, 민감하지 않은 추적 ID만 보내주세요.

승인된 도입 범위에 맞춰 인증, 권한, 응답 대기 제한, 중복 처리와 실패 증빙을 확인합니다.