クイックスタート

このガイドでは、トークンの発行から最初の API 呼び出しの成功までを説明します。

デスクトップのウェブアプリで連携したいチームを開き、設定 > 連携設定に移動します。新しい API トークンを生成してコピーします。

連携チームの取得を呼び出して、トークンが機能することを確認します。トークンは Authorization ヘッダーで送信します。

curl https://rest.boxhero-app.com/v1/teams/linked \
  -H "Authorization: Bearer $BOXHERO_API_TOKEN"

レスポンスには、トークンが属するチームの情報が含まれます。

{
  "id": 149058,
  "name": "Acme Retail",
  "mode": 2,
  "currency_symbol": "$",
  "currency_code": "USD",
  "price_decimal_places": 2,
  "memo": null
}

代わりに 401 が返された場合は、トークンが送信されていないか、コピーが不完全です。エラーの形式についてはエラーをご覧ください。

• 商品一覧の取得で在庫を一覧表示し、ページネーションですべてのページを取得する方法を確認します。
• 履歴の作成で在庫の変動を記録します。ルールについては履歴をご覧ください。
• ポーリングの代わりに Webhook で変更の通知を受け取ります。
• API リファレンスですべてのエンドポイントを確認します。