리소스
API 레퍼런스
Checkout 및 웹훅 엔드포인트, 인증, 응답과 상태 코드를 확인합니다.
Hosted Checkout은 아래 운영 기본 URL을 사용합니다. 별도 안내가 없으면 JSON으로 요청하고 응답받습니다.
#기본 URL
https://app.rantan.xyz/api/v2#인증
세션 생성, 상세 조회, 취소와 모든 웹훅 관리 API에는 상품 소유자의 판매자 JWT가 필요합니다. 공개 Checkout 데이터는 세션 범위로 제한됩니다. 검증에는 소유자 JWT 또는 세션 검증 키가 필요합니다.
| 인증 방식 | 헤더 | 용도 |
|---|---|---|
| Seller JWT | Authorization: Bearer {token} | 세션 생성, 상세 조회, 취소, 웹훅 관리 또는 소유자 검증 |
| Verification key | X-Rantan-Checkout-Verification-Key: {key} | 판매자 백엔드의 세션 완료 검증 |
#Checkout 및 웹훅 엔드포인트
POST
/api/v2/checkout-sessions/서버에 주문 조건이 고정된 Checkout Session을 생성합니다.
GET
/api/v2/checkout-sessions/{sessionId}/checkout/호스티드 Checkout이 사용하는 공개 상품 및 세션 데이터를 조회합니다.
GET
/api/v2/checkout-sessions/{sessionId}/인증된 상품 소유자가 세션을 조회합니다.
DELETE
/api/v2/checkout-sessions/{sessionId}/상품 소유자가 열린 세션을 취소합니다.
GET
/api/v2/checkout-sessions/{sessionId}/verify/판매자 JWT 또는 검증 키로 이행 완료를 검증합니다.
POST
/api/v2/webhooks/endpoints/웹훅 endpoint를 만들고 서명 비밀키를 한 번만 받습니다.
GET
/api/v2/webhooks/endpoints/판매자 소유의 웹훅 endpoint 목록을 조회합니다.
GET
/api/v2/webhooks/endpoints/{endpointId}/웹훅 endpoint 한 건의 설정을 조회합니다.
PATCH
/api/v2/webhooks/endpoints/{endpointId}/웹훅 endpoint 설정을 변경합니다.
DELETE
/api/v2/webhooks/endpoints/{endpointId}/웹훅 endpoint를 비활성화합니다.
POST
/api/v2/webhooks/endpoints/{endpointId}/rotate-secret/서명 비밀키를 회전하고 새 키를 한 번만 받습니다.
GET
/api/v2/webhooks/deliveries/최근 웹훅 전송 이력을 최대 100건 조회합니다.
POST
/api/v2/webhooks/deliveries/{deliveryId}/retry/동일한 event id로 전송을 다시 시도합니다.
#HTTP 상태 코드
| 상태 | 의미 |
|---|---|
200 | 기존 멱등 세션 반환, 조회, 검증 또는 취소가 성공했습니다. |
201 | 새 Checkout Session을 생성했습니다. |
400 | 요청 필드 또는 상품별 옵션이 올바르지 않습니다. |
401 | 판매자 인증이 없거나 올바르지 않습니다. |
403 | 검증 키 또는 인증된 소유자가 세션과 일치하지 않습니다. |
404 | 이 호출자에게 해당 상품 또는 Checkout Session이 없습니다. |
409 | 주문 참조 충돌, 지원하지 않는 상품 상태 또는 이미 처리 시작 상태입니다. |
410 | 구매 시작 전에 Checkout Session이 취소되거나 만료됐습니다. |