品牌 API
在 ANKK 中，每個 Public API 金鑰建立時都會自動綁定至單一品牌。之後的所有 API 請求都會在該品牌的情境中執行。您可以取得品牌詳細資訊，確認金鑰是否有效以及目前的存取狀態。
📌 端點
섹션 제목: “📌 端點”| 方法 | 路徑 | 說明 | 必要權限範圍 |
|---|---|---|---|
GET | /v1/brand | 檢索與 API 金鑰繫結的品牌詳細資訊 | brands:read 或 * |
GET | /v1/brands | 以清單陣列形式檢索繫結的品牌 | brands:read 或 * |
🔍 取得品牌詳細資訊 (GET /v1/brand)
섹션 제목: “🔍 取得品牌詳細資訊 (GET /v1/brand)”驗證您的 spk_... API 金鑰附加在哪個品牌上。
請求範例
섹션 제목: “請求範例”curl -X GET "https://api.ankk.app/v1/brand" \ -H "Authorization: Bearer spk_live_xxxxxxxx"回應範例 (200 OK)
섹션 제목: “回應範例 (200 OK)”{ "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)。請前往 方案與限制 或 帳務指南 檢查訂閱狀態。