コンテンツにスキップ
Docs
Esc
↑↓移動↵開く⌘Jプレビュー

メールアドレスを固定した購入画面を作る

必要なスコープ: checkouts:write。販売者のサーバーが、ログイン中のユーザーのメールアドレスで購入試行を作り、購入画面の URL を返す。購入画面ではメールアドレスを変更できず、照会 API(POST /customers/state)で引くメールアドレスとの食い違いを防ぐ。商品の種類(機能フラグ・購入者限定ページ)は問わない。そのメールアドレスがすでに購入済みで、購入制限に達しているときは 409 already_purchased(作らない)。有効期限は30分。URL には購入者のメールアドレスが紐づくので、ログイン中の本人にだけ渡す。

POST/checkout/sessions
認証
AuthorizationBearer トークン · header必須

管理画面または CLI の cozeni login で発行したクリエイターAPIキー。購入者認証には使わない。

リクエストボディ
必須application/json
product_idstring必須

販売する商品の ID。自分の商品で、標準の購入リンクがあるもの。

最小長 1 · 最大長 200
emailstring<email>必須

購入者のメールアドレス(販売者のアプリでログイン中のユーザーのもの)。前後の空白を除き、小文字にそろえて保存する。購入画面では変更できない。URL には載せない(POST)。

最大長 254
レスポンス
201

購入試行の ID・購入画面の URL・有効期限。

checkout_idstring必須

購入試行の ID。

urlstring<uri>必須

購入画面の URL(?checkout=<checkout_id> 付き)。購入者をこの URL へ進める。メールアドレスは含まない。

expires_atstring<date-time>必須

購入画面の有効期限(作成から30分)。過ぎたら作り直す。

400

invalid_input。メール形式の誤り・product_id なし・未知フィールド・JSON でない本文。

errorobject必須
プロパティを表示
codestring必須
messagestring必須
request_idstring必須
401

unauthorized。失効、期限切れ、環境違いを含む。

errorobject必須
プロパティを表示
codestring必須
messagestring必須
request_idstring必須
403

insufficient_scope。checkouts:write が必要。

errorobject必須
プロパティを表示
codestring必須
messagestring必須
request_idstring必須
404

product_not_found。他の販売者の商品・存在しない商品・標準リンクが無い商品。

errorobject必須
プロパティを表示
codestring必須
messagestring必須
request_idstring必須
409

creator_not_ready(審査未承認・Stripe 未接続)または already_purchased(購入済みで購入制限に達している)。

errorobject必須
プロパティを表示
codestring必須
messagestring必須
request_idstring必須
410

product_archived(アーカイブ済み・未公開)または checkout_link_disabled(標準リンクが無効)。既存の購入画面と同じ。

errorobject必須
プロパティを表示
codestring必須
messagestring必須
request_idstring必須
422

sandbox_recipient_not_allowed。サンドボックスで、販売者本人のサインイン用メールアドレス以外を指定した。

errorobject必須
プロパティを表示
codestring必須
messagestring必須
request_idstring必須
429

rate_limited。管理 API と同じ枠(キー・販売者・IP)。

errorobject必須
プロパティを表示
codestring必須
messagestring必須
request_idstring必須
500

internal。DB の障害を含む。

errorobject必須
プロパティを表示
codestring必須
messagestring必須
request_idstring必須
リクエスト
curl -X POST 'https://api.cozeni.net/external/v1/checkout/sessions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "product_id": "prd_0123456789abcdef0123456789abcdef",
  "email": "hanako@example.com"
}'
レスポンス
{
  "checkout_id": "string",
  "url": "http://example.com",
  "expires_at": "2019-08-24T14:15:22Z"
}

このページは役に立ちましたか?