시스템 연동 가이드

연결할 고객 업무 한 가지를 정한 뒤 인증, 작업 공간 범위, 권한, 요청 ID, 재시도, 오류 처리, 감사 기록, 미처리 업무 담당자를 정의합니다.

인증 정보는 브라우저 밖에 보관합니다.서버 연동 설계 예시입니다. 사용 가능한 작업은 승인된 계약 명세로 정합니다.

오류를 성공으로 바꾸지 않습니다.

입력 오류, 권한 오류, 충돌, 요청 제한, 일시적 장애를 각각 처리합니다.

계약 명세 예제와 구현 맥락

연동 규약 예시

GET/knowledge/facts

공개된 API 계약이 기준입니다. 예제는 구현 방법을 설명할 뿐 작업 권한이나 인증 정보를 부여하지 않습니다.

연동 구현 체크리스트

연결 범위와 실패 처리 방법을 확인할 수 있는 서버 연동을 만드세요.

공개된 API 계약이 기준입니다. 예제는 구현 방법을 설명할 뿐 작업 권한이나 인증 정보를 부여하지 않습니다.

const response = await fetch(`${origin}/knowledge/facts`, {
  headers: { Authorization: `Bearer ${token}` },
  signal: AbortSignal.timeout(5000)
});

if (!response.ok) {
  const failure = await decodeFailure(response);
  return handleByStatus(failure);
}

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

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

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

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

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

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

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

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

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