ブランド API

ANKK では、作成時に各パブリック API キーが自動的に単一のブランドに紐付けられます。それ以降のすべての API リクエストは、そのブランドのコンテキスト内で実行されます。ブランドの詳細を取得して、キーの有効性とアクセスステータスを確認できます。

📌 エンドポイント

メソッド	パス	説明	必要なスコープ
`GET`	`/v1/brand`	API キーに紐付いたブランドの詳細を取得	`brands:read` または `*`
`GET`	`/v1/brands`	キーに紐付いたブランドをリスト配列で取得	`brands:read` または `*`

お使いの spk_... API キーがどのブランドに紐付いているかを確認します。

curl -X GET "https://api.ankk.app/v1/brand" \
  -H "Authorization: Bearer spk_live_xxxxxxxx"

{
  "brand_ref": "brand_01jm8v4k9example",
  "name": "ACME Studio",
  "slug": "acme-studio",
  "role": "owner",
  "is_locked": false
}

フィールド	型	説明
`brand_ref`	`string`	ユニークなブランド識別子 (ULID 形式)
`name`	`string`	ブランドの表示名
`slug`	`string`	URL パスで使用されるユニークなスラッグ
`role`	`string`	キー発行者の権限ロール (`owner`)
`is_locked`	`boolean`	請求またはポリシーの制限によりブランドがロックされているかどうかを示します

[!IMPORTANT] is_locked: true の場合、公開および書き込み操作は 423 Locked (brand_locked) でブロックされます。プランと制限または請求ガイドでサブスクリプションを確認してください。