跳到內容

驗證

使用 Bearer 權杖驗證 BoxHero API 請求,並將請求傳送至含版本的基礎 URL。

每個請求都必須在 Authorization 標頭中以 Bearer 權杖的形式攜帶 API 權杖:

Authorization: Bearer <api-token>

請在 BoxHero 應用程式的 設定 > 整合和 API 中發行權杖。每個權杖只綁定一個團隊:所有請求都只讀寫該團隊的資料。若要操作多個團隊,請在每個團隊中分別發行權杖。

不支援匿名存取。權杖缺少或無效時,所有端點都會傳回 401 與錯誤封包。

所有請求都傳送至:

https://rest.boxhero-app.com

所有端點都位於 /v1 前綴之下,例如 GET /v1/items。

大多數端點僅適用於依位置管理庫存的團隊。對於其他團隊,這些端點會傳回 400 與錯誤類型 /errors/invalid-team-mode。團隊、成員、合作夥伴與屬性端點適用於所有團隊。呼叫取得連結的團隊即可查看您的團隊使用的模式。