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

購入者の機能フラグを照会する

必要なスコープ: customers:read。購入者のメールアドレスで、付与済みの機能フラグと設定値を返す。購入者がいない・機能フラグの権利が無いときも 200(customer_id: null・feature_flags: [])。同じ購入者の結果は最大60秒キャッシュしてよい。購入直後は反映まで数秒かかることがあるので、見つからなければ数秒おきに数回照会し直す。ログインのメールアドレスの本人確認は販売者のアプリで済ませること。

POST/customers/state
認証
AuthorizationBearer トークン · header必須

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

リクエストボディ
必須application/json
emailstring<email>必須

購入者のメールアドレス。前後の空白を除き、大文字小文字を区別せずに照合する。URL には載せない(POST)。

最大長 254
レスポンス
200

購入者の ID と機能フラグ。機能フラグの権利が1件以上あるときだけ customer_id を返す。無ければ customer_id: null・空配列。

customer_idstring | null必須

この販売者の購入者の ID。機能フラグの権利が1件以上あるときだけ返す。無ければ null(購入者の有無・購入済みかどうかの判定には使えない)。

feature_flagsExternalFeatureFlag[]必須

付与済み(剥奪されていない)の機能フラグ。商品ごとに1件(商品の種類の設定 benefit は1商品に1つ)。付与日時の昇順。購入者限定ページの権利は含まない。

プロパティを表示
ExternalFeatureFlag の配列
product_idstring必須
benefit_idstring必須
granted_atstring<date-time>必須

権利が最初に付与された日時。同じ商品を複数回購入していれば最も古いもの。

metadataExternalFeatureFlagMetadata必須

機能フラグの設定値。50件まで。キーは1〜40字の英数字・_・-(proto は不可)。値は文字列(1〜500字)・数値・真偽値。URLやAPIキーなどの秘匿情報は入れない。

400

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

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

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

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

insufficient_scope。customers:read が必要。

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/customers/state' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "hanako@example.com"
}'
レスポンス
{
  "customer_id": "string",
  "feature_flags": [
    {
      "product_id": "string",
      "benefit_id": "string",
      "granted_at": "2019-08-24T14:15:22Z",
      "metadata": {
        "daily_messages": 100,
        "plan": "pro",
        "beta": true
      }
    }
  ]
}

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