Cozeni 外部 API
Cozeni の外部 API は、販売者のサーバーから商品・購入リンク・購入画面を操作し、購入者のアクセス権を確かめるための API です。API はサーバーから呼び出します。任意のオリジンからの CORS 付きの呼び出しには対応していません。
ベース URL は環境ごとに違います。API キーも環境ごとに発行し、別の環境のキーを送ると 401 unauthorized が返ります。
| 環境 | ベース URL | API キーの接頭辞 |
|---|---|---|
| 本番 | https://api.cozeni.net/external/v1 |
cozeni_sk_ |
| サンドボックス | https://api-sandbox.cozeni.net/external/v1 |
cozeni_sk_sandbox_ |
サンドボックスでは実際の請求は発生しません。詳しくは サンドボックス を参照してください。
販売者のサーバーは API キーを Authorization: Bearer <APIキー> で送ります。購入者の確認には購入者の Cookie(cozeni_customer)を使います。購入者の入場コードの交換と CLI のログインには API キーは要りません。詳しくは 認証 を参照してください。
次の例は、API キーで商品の一覧を取得します。キーには products:read の権限が要ります。
curl "https://api.cozeni.net/external/v1/products" \
-H "Authorization: Bearer $COZENI_API_KEY"
公式 SDK(@nulogic/cozeni-sdk)を使うと、購入者の入場と権利の確認をまとめて扱えます。SDK の概要 を参照してください。
バージョン 1.0.0
ベース URL
https://api.cozeni.net/external/v1https://api-sandbox.cozeni.net/external/v1アカウント
商品
- GET商品の一覧を取得する
/products - POST商品を作る
/products - GET商品を1件取得する
/products/{product_id} - PATCH商品を更新する
/products/{product_id} - PUT商品の画像を設定する
/products/{product_id}/image - DELETE商品の画像を削除する
/products/{product_id}/image
購入リンク
- GET商品の購入リンクを取得する
/products/{product_id}/checkout-link - PUT商品の購入リンクを取得し、無ければ発行する
/products/{product_id}/checkout-link
購入画面
購入者
- POST60秒・単回コードを購入者JWTへ交換する
/customer/handoff/exchange - POST購入者の商品アクセス権を判定する
/customer/entitlements/check - POST購入者ポータルを開く1回限り・60秒のURLを発行する
/customer/portal-link - POST購入者の機能フラグを照会する
/customers/state
テスト購入
- POSTテスト購入を行う(サンドボックスのみ)
/products/{product_id}/test-purchase - POSTテスト購入を返金する(サンドボックスのみ)
/products/{product_id}/test-purchase/refund