---
seo:
  description: Cozeni の外部 API は、販売者のサーバーから商品・購入リンク・購入画面を操作し、購入者のアクセス権を確かめるための API です。API…
sidebar:
  label: 概要
title: 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_` |

サンドボックスでは実際の請求は発生しません。詳しくは [サンドボックス](/integrate/sandbox) を参照してください。

販売者のサーバーは API キーを `Authorization: Bearer <APIキー>` で送ります。購入者の確認には購入者の Cookie（`cozeni_customer`）を使います。購入者の入場コードの交換と CLI のログインには API キーは要りません。詳しくは [認証](/integrate/authentication) を参照してください。

次の例は、API キーで商品の一覧を取得します。キーには `products:read` の権限が要ります。

```sh
curl "https://api.cozeni.net/external/v1/products" \
  -H "Authorization: Bearer $COZENI_API_KEY"
```

公式 SDK（`@nulogic/cozeni-sdk`）を使うと、購入者の入場と権利の確認をまとめて扱えます。[SDK の概要](/integrate/sdk) を参照してください。

- [エラー](/api-reference/errors)：エラーの形式と、API ごとのエラーコード
- [ページ送り](/api-reference/pagination)：一覧の API で結果をページに分けて取得する方法
- [レート制限](/api-reference/rate-limits)：呼び出し回数の上限
- [バージョン](/api-reference/versioning)：バージョンの表し方と互換性の方針

Version 1.0.0

Base URL: `https://api.cozeni.net/external/v1`, `https://api-sandbox.cozeni.net/external/v1`

## アカウント

- [`GET /account`](/api-reference/account/external-get-account) — 接続中のアカウントと販売できる状態を取得する.

## 商品

- [`GET /products`](/api-reference/products/external-list-products) — 商品の一覧を取得する.
- [`POST /products`](/api-reference/products/external-create-product) — 商品を作る.
- [`GET /products/{product_id}`](/api-reference/products/external-get-product) — 商品を1件取得する.
- [`PATCH /products/{product_id}`](/api-reference/products/external-update-product) — 商品を更新する.
- [`PUT /products/{product_id}/image`](/api-reference/products/external-put-product-image) — 商品の画像を設定する.
- [`DELETE /products/{product_id}/image`](/api-reference/products/external-delete-product-image) — 商品の画像を削除する.

## 購入リンク

- [`GET /products/{product_id}/checkout-link`](/api-reference/checkout-links/external-get-checkout-link) — 商品の購入リンクを取得する.
- [`PUT /products/{product_id}/checkout-link`](/api-reference/checkout-links/external-ensure-checkout-link) — 商品の購入リンクを取得し、無ければ発行する.

## 購入画面

- [`POST /checkout/sessions`](/api-reference/checkout/external-create-checkout-session) — メールアドレスを固定した購入画面を作る.

## 購入者

- [`POST /customer/handoff/exchange`](/api-reference/customer/external-exchange-handoff) — 60秒・単回コードを購入者JWTへ交換する.
- [`POST /customer/entitlements/check`](/api-reference/customer/external-check-entitlements) — 購入者の商品アクセス権を判定する.
- [`POST /customer/portal-link`](/api-reference/customer/external-create-portal-link) — 購入者ポータルを開く1回限り・60秒のURLを発行する.
- [`POST /customers/state`](/api-reference/customer/external-get-customer-state) — 購入者の機能フラグを照会する.

## テスト購入

- [`POST /products/{product_id}/test-purchase`](/api-reference/test-purchases/external-start-test-purchase) — テスト購入を行う（サンドボックスのみ）.
- [`POST /products/{product_id}/test-purchase/refund`](/api-reference/test-purchases/external-refund-test-purchase) — テスト購入を返金する（サンドボックスのみ）.

## CLI

- [`POST /cli/device-codes`](/api-reference/cli/external-create-cli-device-code) — CLIのログインを始め、承認用のコードを発行する.
- [`POST /cli/tokens`](/api-reference/cli/external-create-cli-token) — 承認を確かめ、承認済みならCLI用のAPIキーを発行する.
- [`POST /cli/logout`](/api-reference/cli/external-cli-logout) — CLIで発行したキーを失効する.
