본문으로 건너뛰기
SALERINGOSITE v1.27.0

API 참조

전체 승인 통합 패키지를 요청하기 전에 하나의 완전한 요청, 응답, 권한, 중복 처리 방지 및 실패 계약을 검토하세요.

계약 명세로 요청과 결과를 연결합니다.API 계약 명세 예시입니다. 예제는 쓰기 권한을 부여하지 않습니다.
  1. 01
    명령
    작업
    POST /cases
    권한
    case.create
  2. 02
    검증
    필수
    승인된 데이터 항목
    중복 방지
    Idempotency-Key
  3. 03
    접수 결과
    HTTP
    201
    추적
    X-Request-Id
접수와 업무 완료는 다릅니다.

문서화된 응답과 생성된 업무 기록을 함께 확인해 실제 처리 결과를 판단합니다.

계약 명세 예제와 구현 맥락
필드, 권한, 오류 처리 방식을 함께 정하는 구축팀
실행하기 전에 작업, 필드, 권한 및 실패 계약에 동의합니다.
연동 규약 예시
POST/cases
권한
case.create
중복 처리 방지의 장점
*필수
응답
기기
추적
요청 ID

출판된 API 계약은 이 참조에 나열된 작업에 대해 검증됩니다. 여전히 서명 된 범위와 고객사가 발행 한 자격에 따라 사용할 수 있습니다.

연동 구현 체크리스트

승인된 범위에 게시 된 작업 및 권한 만 구현하세요.

출판된 API 계약은 이 참조에 나열된 작업에 대해 검증됩니다. 여전히 서명 된 범위와 고객사가 발행 한 자격에 따라 사용할 수 있습니다.

  1. 읽으세요작업 상태, 쿼리 필드, 질 및 응답 모양을 가져옵니다.
  2. 명령쓰기 요청은 고유한 Idempotency-Key로 중복 처리를 막으며, 최신 버전이나 추가 확인이 필요할 수 있습니다.
  3. 비밀번호인증, 허가, 분쟁, 유효성 검사, 요청량 제한 및 서비스 실패를 다르게 대우하세요.
  4. 관찰요청 ID를 보존하기 때문에 팀과 Saleringo는 동일한 시도를 논의 할 수 있습니다.

요청과 처리 결과

예제 관리 명령

POST /cases
Authorization: Bearer <server-token>
Idempotency-Key: <unique-command-key>
Content-Type: application/json

{ "subject": "Callback request" }

예제 승인된 결과

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

{ "id": "case_...", "status": "open" }

오류별 대응 방법

상태의미고객사 시스템 처리
401인증 정보가 없거나 만료되었거나 올바르지 않음요청을 중지하고 승인된 서버 절차로 인증 정보를 갱신합니다.
403요청한 작업에 필요한 권한 또는 범위가 없음다시 시도하지 말고 접근 권한 검토를 요청합니다.
409상태, 버전, 중복 처리 방지 키, 승인 상태가 충돌함충돌 내용을 확인하고 상태를 맞춘 뒤 다음 요청을 보냅니다.
422요청 형식이 공개된 스키마와 일치하지 않음오류에 표시된 필드를 수정한 뒤 다시 요청합니다.
429짧은 시간에 요청을 너무 많이 보냄응답에 안내된 대기 시간에 맞춰 요청 간격을 늘립니다.
5xx일시적인 서비스 오류가 발생했을 수 있음요청 ID를 보관하고 해당 작업이 재시도를 허용할 때만 다시 시도합니다.

구현 지원

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

연락처 경로 열기

연동 규약을 먼저 확인하세요.

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

시스템 연동 가이드 보기