リソース
API リファレンス
Checkout・Webhook のエンドポイント、認証、レスポンス、ステータスコードです。
Hosted Checkout は以下の本番ベース URL を使用します。特記がない限り JSON で送受信します。
#ベース URL
https://app.rantan.xyz/api/v2#認証
セッション作成、詳細、キャンセル、すべての Webhook 管理 API には商品所有者の販売者 JWT が必要です。公開 Checkout データはセッション範囲に限定されます。検証には所有者 JWT またはセッション検証キーが必要です。
| 認証方式 | ヘッダー | 用途 |
|---|---|---|
| Seller JWT | Authorization: Bearer {token} | セッション作成、詳細、キャンセル、Webhook 管理、所有者検証 |
| Verification key | X-Rantan-Checkout-Verification-Key: {key} | 販売者バックエンドでの完了検証 |
#Checkout・Webhook エンドポイント
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/Webhook endpoint を作成し、署名 secret を一度だけ受け取ります。
GET
/api/v2/webhooks/endpoints/販売者所有の Webhook endpoint 一覧を取得します。
GET
/api/v2/webhooks/endpoints/{endpointId}/Webhook endpoint 1件の設定を取得します。
PATCH
/api/v2/webhooks/endpoints/{endpointId}/Webhook endpoint の設定を変更します。
DELETE
/api/v2/webhooks/endpoints/{endpointId}/Webhook endpoint を無効化します。
POST
/api/v2/webhooks/endpoints/{endpointId}/rotate-secret/署名 secret をローテーションし、新しい secret を一度だけ受け取ります。
GET
/api/v2/webhooks/deliveries/直近100件までの Webhook 配信履歴を取得します。
POST
/api/v2/webhooks/deliveries/{deliveryId}/retry/同じ event id で配信を再試行します。
#HTTP ステータスコード
| 状態 | 意味 |
|---|---|
200 | 既存の冪等セッション、読み取り、検証、キャンセルが成功しました。 |
201 | 新しい Checkout Session を作成しました。 |
400 | リクエスト項目または商品固有オプションが不正です。 |
401 | 販売者認証がない、または無効です。 |
403 | 検証キーまたは認証済み所有者がセッションと一致しません。 |
404 | この呼び出し元に該当する商品または Checkout Session がありません。 |
409 | 注文参照の競合、未対応の商品状態、または処理開始済みです。 |
410 | 購入開始前に Checkout Session がキャンセルまたは期限切れになりました。 |