API
BoxHeroのAPIを使うと、開発者は当社の在庫管理機能を外部アプリケーションと統合して、効率的にデータを取得・連携できます。
APIリファレンス
詳細なエンドポイントのドキュメントについては、以下をご覧ください： https://rest.boxhero-app.com/docs/api
エンドポイント
すべてのAPIリクエストは、次のベースURL宛てに送信してください： https://rest.boxhero-app.com
認証
すべてのAPIリクエストには、 Authorization ヘッダーと Bearerトークン:
APIトークンを取得するには：
Desktop（Web）でBoxHeroアカウントにログインします。
に移動して
設定>連携.新しいAPIトークンを生成します。
リクエストの作成
以下は、商品を取得するためのAPIリクエストのサンプルです。
レート制限
システムの安定性を確保するため、以下のレート制限を設けています：
各エンドポイントにつき1秒あたり5クエリ。
レート制限に達すると、次の内容を含むエラーメッセージが表示されます：
X-Ratelimit-Limit- 1分あたりの最大クエリ数X-Ratelimit-Remaining- 残りのクエリ数X-Ratelimit-Reset- クエリ数のリセットまでの残り時間（秒）
レスポンス
成功
HTTPステータスコードが200番台のレスポンスは、API処理が成功したことを示します。
エラー
400番台または500番台のステータスコードは、APIリクエストの失敗を示します：
400番台：リクエストで提供された情報に起因するクライアント側エラー（例：必須パラメータの欠落）。
500番台：サーバー側エラー。
エラーレスポンスの例：
id : エラーを識別するための一意のIDです。
type : エラーの種類を識別するURL形式のコードです。
title : エラーの内容を人が読める形式で示します。
correlation_id : エラーに関連するリクエストのIDを示します。
その他 : 追加情報を提供するために、次のような追加フィールドが含まれる場合があります："given" は例です。
一般的なエラータイプ
/errors/not-found
要求されたリソースが見つかりません（例：特定のIDを持つアイテムが存在しない）。
/errors/invalid-request
リクエスト内のパラメータが無効です。
/errors/invalid-team-mode
要求されたクエリは現在のチームモードでは処理できません（例： 場所 lookup APIを Basicモードで).
/errors/tokens/required
APIトークンがありません。
/errors/tokens/invalid
無効なAPIトークンです（例：APIトークンの有効期限切れ）。
/errors/too-many-requests
レート制限を超えました。
/errors/unhandled
未解決のサーバー側エラー。
/errors/core/usage-limit-exceeded
利用制限に達しました。プランのアップグレードが必要です。
ページネーション
大きなデータセットを返すエンドポイント（例：アイテム一覧、トランザクション一覧）では、一覧表示APIがページネーションによって1回のリクエストで返すアイテム数を制限します。カーソルベースのページネーションを使用しています：
ページネーションが必要かどうかを判断するには、APIドキュメント内のエンドポイントのリクエスト本文にページネーション関連のパラメータが含まれているか確認してください。
ページネーションパラメータ
has_more：現在のページの先にさらにデータが存在するかどうかを示すブール値です。cursor：次のページを取得するためのカーソル値を提供します。
次のページの取得
次の内容を確認します
has_moreがtrueであれば、別のページが利用可能であることを意味します。もし
true。次に、cursor={受け取ったカーソル値}をパラメータに含めて再度リクエストを送信します。これにより次のデータが返されます。全件を取得するまで、
has_moreがfalseになるまで繰り返します。
サポートとフィードバック
問題が発生した場合や追加のAPI機能が必要な場合は、 サポートチームまでご連絡ください。APIの改善や新機能のリクエストに関するフィードバックを歓迎します。
最終更新