コンテンツにスキップ

認証

Bearer トークンで BoxHero API のリクエストを認証し、バージョン付きのベース URL に送信します。

すべてのリクエストには、Authorization ヘッダーに Bearer トークンとして API トークンを含める必要があります。

Authorization: Bearer <api-token>

トークンは BoxHero アプリの 設定 > 連携設定で発行します。各トークンは 1 つのチームに紐づき、すべてのリクエストはそのチームのデータのみを読み書きします。複数のチームを扱うには、それぞれのチームでトークンを発行してください。

匿名アクセスには対応していません。トークンが送信されていないか無効な場合、すべてのエンドポイントは 401 とエラーエンベロープを返します。

すべてのリクエストの送信先は次のとおりです。

https://rest.boxhero-app.com

すべてのエンドポイントは /v1 プレフィックスの下にあります(例: GET /v1/items)。

ほとんどのエンドポイントは、ロケーションで在庫を管理するチームでのみ使用できます。それ以外のチームでは、400 とエラータイプ /errors/invalid-team-mode が返されます。チーム、メンバー、取引先、属性のエンドポイントはすべてのチームで使用できます。チームのモードを確認するには、連携チームの取得を呼び出してください。