Skip to content

品牌 API

在 ANKK 中,每個 Public API 金鑰建立時都會自動綁定至單一品牌。之後的所有 API 請求都會在該品牌的情境中執行。您可以取得品牌詳細資訊,確認金鑰是否有效以及目前的存取狀態。


方法路徑說明必要權限範圍
GET/v1/brand檢索與 API 金鑰繫結的品牌詳細資訊brands:read 或 *
GET/v1/brands以清單陣列形式檢索繫結的品牌brands:read 或 *

🔍 取得品牌詳細資訊 (GET /v1/brand)

Section titled “🔍 取得品牌詳細資訊 (GET /v1/brand)”

驗證您的 spk_... API 金鑰附加在哪個品牌上。

Terminal window
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_refstring唯一品牌識別碼
namestring品牌的顯示名稱
slugstring用於 URL 路徑的唯一代稱
rolestring金鑰簽發者的權限角色 (owner, admin, member)
is_lockedboolean指示品牌是否因帳單或政策限制而被鎖定

[!IMPORTANT] 如果 is_locked: true,發佈與寫入操作會遭到阻擋,並傳回 423 Locked (brand_locked)。請前往 方案與限制 或 帳務指南 檢查訂閱狀態。