Skip to main content

認證方式

帳獸 API 使用 Bearer Token 進行認證。每個 API 請求都必須在 Authorization 標頭中附帶有效的 Token。
Authorization: Bearer YOUR_API_TOKEN

取得 Token

你可以在後台的金鑰管理頁面建立 API Token。詳見 API 金鑰管理
Token 只會在建立時顯示一次,請立即複製並妥善保存。

使用範例

curl -X GET https://api.zangsho.com/v1/customers \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

認證失敗

如果 Token 無效、已過期或未提供,API 會回傳 401 Unauthorized
{
  "message": "Unauthenticated."
}

常見原因

原因說明
未附帶 Token請求未包含 Authorization 標頭
Token 格式錯誤確認格式為 Bearer YOUR_TOKEN(注意 Bearer 後有空格)
Token 已撤銷Token 已被手動撤銷,需建立新的
Token 已重新生成重新生成後舊 Token 立即失效

Token 權限

每個 Token 包含以下 abilities:
權限說明對應端點
customers:read讀取客戶資料GET /customers, GET /customers/{id}
customers:write建立、更新、刪除客戶POST /customers, PUT /customers/{id}, DELETE /customers/{id}
orders:read讀取訂單資料GET /orders, GET /orders/{orderNo}, GET /orders/stats
orders:write建立訂單POST /orders
subscriptions:read讀取訂閱資料GET /subscriptions, GET /subscriptions/{id}
subscriptions:write建立、更新、刪除訂閱POST /subscriptions, PUT /subscriptions/{id}, DELETE /subscriptions/{id}
如果你的 Token 沒有對應的權限,API 會回傳 403 Forbidden

安全建議

  • 將 Token 存放在環境變數中,不要寫在程式碼裡
  • 不要在前端(瀏覽器)使用 Token
  • 不要將 Token 提交到版本控制系統
  • 定期輪換 Token,特別是在人員異動時