API リクエストでエラーが発生した際のトラブルシューティングガイド

1. エラーメッセージやステータスコードを確認します。

これらは問題解決のための重要な情報になります。ここでは代表的ないくつかの API 種別の場合を取り上げます。

REST API でエラーが発生した場合

エラーが発生した場合、または応答が正常な場合のどちらでも、応答ヘッダーには HTTP コードが含まれ、レスポンスボディには通常、状況コードとエラー応答情報が含まれます。

SOAP API でエラーが発生した場合

不正に作成されたメッセージ、失敗した認証、または同様の問題によるエラーについて、API は、関連する ExceptionCode を使用して SOAP エラーメッセージを返します。

Bulk API/Bulk API 2.0 でエラーが発生した場合

Bulk API での処理の実行中、エラーが返されることがあります。エラーコードと、その原因と思われる Bulk API アクションを確認します。

2. API 要求の制限や割り当て範囲内の利用であるかを確認します。

下記の制限と割り当ては Salesforce Platform の SOAP API と REST API、およびこれらのフレームワーク上に構築されたその他の API に適用されます。

API 要求の制限と割り当て

組織の API 使用状況および制限をより詳細に監視するには、次のリソースを使用してください。

・[設定] の [システムの概要] ページの [API 使用状況] セクション。

・[設定] の [組織情報] ページの [組織の詳細] セクションにある [API 要求数 (この 24 時間以内)]。

・使用量ベースのエンタイトルメントの [API Request Limit per Month (月間 API 要求制限)]。ここには、組織の API コールの 30 日間の集計が表示されます。この情報は [設定] の [組織情報] ページにあります。

・REST API の Sforce-Limit-Info 応答ヘッダーで返される情報。

・SOAP API の (<type>API REQUESTS</type> 内の) レスポンスボディで返される情報。

・Lightning Platform REST API の /limits コール。

Bulk API の場合は以下の制限および割り当てへの考慮が必要です。

Bulk API および Bulk API 2.0 の制限および割り当て

Connect REST API などのその他の Salesforce API の制限については、各 API のドキュメントを参照してください。

3. 一時的なエラーに備えてリクエストの自動リトライを検討する

API リクエストでは一時的なエラーが応答される場合があります。API サービスの一時的な高負荷状態やネットワーク経路上の問題などその要因は様々ですが、実際の利用では少なからず一時的なエラーに遭遇する可能性があります。そのため、こうした一時的なエラーが発生することをあらかじめ想定し、リトライの仕組みを検討します。自動でのリトライを実装することで、 API サービスをより安定的に利用できます。

上記ガイドの内容をすべて確認しても問題が解決しない場合、以下情報を添えてサポートに問い合わせてください。

・エラーが発生した組織の組織 ID

・API の実行ユーザー (ユーザー名)

・API 種別 (REST API, SOAP API, Bulk API 等)

・リクエスト日時 (タイムゾーン併記)

・リクエスト URL、メソッド

・リクエスト Body

・レスポンス Body

また、これまでエラーが発生していなかったリクエストでエラーが発生するようになった場合はリクエストの内容に依存しない問題の可能性も考えられるため、下記の情報でも構いません。

・エラーが発生した組織の組織 ID

・API の実行ユーザー (ユーザー名)

・API 種別 (REST API、SOAP API 等)

・エラーが確認された時間帯 (タイムゾーン併記)

・エラーのおおよその頻度 (例 : 3 分間に 10 リクエスト中 8 回発生など)

・ご利用のクライアントツールの情報（Dataloader、別の Salesforce 組織、独自のJavaクライアント等）

・詳細な処理内容（例：SOAP APIのメソッド名（query() など）、REST API のエンドポイント URL など）

・そのほか、エラーの詳細がわかる情報 (レスポンス Body、API クライアントのアプリ上のログ、SOQL など)