エラーの例
バージョン管理されているAPIコールの使用時に、バージョン管理に関連したエラーが発生する場合があります。このリファレンスでは、エラーが表示される最も一般的なケースを挙げ、そのようなエラーの例を示します。正しくないbox-versionヘッダーを使用した呼び出し
正しくないbox-versionヘッダーを使用してAPIを呼び出すと、APIはHTTP error code 400 - Bad Requestエラーで応答し、レスポンスのメッセージ内にサポート対象のバージョンを示します。
レスポンスのmessageフィールドには、以下のステータスメッセージのいずれかが含まれます。
box-versionヘッダーが正しくない場合のレスポンスの例:
URLでの正しくないAPIバージョンの呼び出し
Boxのドキュメントでは、APIのURLが示されています。たとえば、署名リクエストのエンドポイントへのアクセスにはhttps://api.box.com/2.0/sign_requests/を使用します。誤ってhttps://api.box.com/3.0/sign_requests/のような正しくないバージョンを呼び出すと、レスポンスではHTTP error code 404 - Not Foundエラーが返されます。
非推奨のAPIの呼び出し
Boxで非推奨としてマークされたAPIバージョンを使用した場合、APIは通常どおり応答します。また、非推奨になった日付を示すDeprecationヘッダーが追加されます。次に例を示します。
Deprecationヘッダーが存在するかどうかを確認し、その結果に応じて新しいAPIバージョンへの移行を計画する必要があります。
存在しないバージョンの呼び出し
公式サポートが終了した古いAPIバージョン (2025.0など) を使用しようとすると、レスポンスではHTTP error code 404 - Not Foundが返されます。詳細については、URLでの正しくないAPIバージョンの呼び出しを参照してください。