身份驗證與 API 金鑰

公開 API 使用以 spk_ 為前綴的 Bearer API 金鑰。

Authorization: Bearer spk_...

品牌範圍 (Brand Scoping)

每個 API 金鑰都僅限於單一品牌。/v1/brand/* 端點所針對的品牌由金鑰本身決定，您無法在請求主體中指定不同的品牌。

只有品牌擁有者才能生成和發放 API 金鑰。

權限範圍與權限 (Scopes & Permissions)

根據端點的不同，會檢查以下權限範圍：

brands:read, brands:write
connections:read
publishing:read, publishing:write
comments:read, comments:write, comments:moderate
analytics:read
webhooks:read, webhooks:write

如果 API 金鑰缺少必要的權限範圍，伺服器會傳回 403 insufficient_scope。

無需驗證的端點

/
/v1/health
/v1/docs
/v1/openapi.json

方案配額

免費品牌允許擁有一把作用中的 API 金鑰，且每個日曆月（UTC）允許 1,000 次計費 API 請求。增長品牌支援多把作用中的金鑰，並在合理使用政策下運作。

在有效驗證後發出的成功和失敗請求都會計入免費配額。健康檢查、API 文件、OpenAPI 架構請求以及無效金鑰請求則不計入次數計算。

安全建議

將金鑰儲存在環境變數或機密資料管理服務中。
絕不要將金鑰包含在客戶端瀏覽器程式碼中。
在日誌輸出中遮蓋金鑰。
停用不使用的金鑰，並定期更換新金鑰。
為每個自動化指令碼使用不同的金鑰，以便區分存取日誌。

🔗 相關文件