英語からAIを使用して翻訳されました
この文章はAI技術を使用して翻訳されたことにご注意ください。正確性を維持するよう努めていますが、一部の詳細は元のテキストを完全に反映していない場合があります。情報に不明な点がある場合は、英語版を参照してください。
APIエラーの表示は、サイトパフォーマンスと顧客体験を時間をかけて監視するのに役立ちます。サイト目標に最も影響を与えているAPIエラーを特定し、エラーの根本原因を見つけて解決します。
APIとAPIエラーについての詳細を読む
APIとは何ですか？
アプリケーションプログラミングインターフェース（API）は、2つのアプリケーションが互いに通信できるようにするソフトウェアの仲介者です。APIには、たとえば、ウェブブラウザとサーバー間の相互作用を促進するためのプロトコル、手順、およびツールのセットがあります。
モバイルデバイスやデスクトップで天気アプリをチェックするたびに、APIを使用しています。
アプリはインターネットに接続し、データをサーバーに送信します。サーバーはそのデータを取得し、解釈し、必要なアクションを実行し、再びあなたのマシンに送信します。あなたの天気アプリはそのデータを解釈し、情報を表示します。
APIエラーとは何ですか？
APIエラーは、APIリクエストに何か問題が発生したときに発生します。たとえば、パラメータが欠落している場合やタイプミスがある場合です。
これらのエラーの一部は顧客体験に影響を与える可能性がありますが、他のエラーはユーザーによって検出されないことがあります。APIエラーを監視することで、サイトのパフォーマンスの低下が応答しないまたはエラーのあるAPIリクエストによるものでないことを確認できます。
例：
支払いプロバイダーAPIがリクエストのタイプミスのために応答していない場合、訪問者は購入を完了できません。また、在庫APIがパラメータが欠落しているために正しいデータを表示していない場合、ユーザーは利用できない商品を購入できるかもしれません。
APIエラーの収集方法
収集されたAPIコール
APIエラー監視によるエラー分析は、ユーザーエージェント（ブラウザ）からサーバーに送信される2種類のHTTPベースのAPIを追跡します：
- XMLHttpRequest API：ユーザーエージェント（ブラウザ）とサーバー間でデータを交換するために最も一般的に使用されるAPIです。
- Modern Fetch API：XMLHttpRequest APIに似ていますが、より強力で柔軟な機能セットを持っています。
ページビューごとに収集されたエラー
ページビューごとに最大20のAPIエラーが収集されます。
エラーエクスプローラーからAPIエラーをフィルタリングする
1. エラーエクスプローラーに移動し、APIエラーをフィルタリングします。
2. 利用可能なエラータブの1つを選択して、エラーの影響を詳しく調べます。
3. エラーをクリックして、エラーの詳細を表示するサイドパネルを開きます。
4. '再生を表示'をクリックしてセッションを再生し、分析を続けます。
APIの詳細を共有する
1. エラーサイドパネルを開きます。
2. 'エラー詳細をコピー'ボタンをクリックしてコピーし、共有します。
各個別のエラーについて以下の詳細が表示されます：
リクエストURL - リクエストの宛先（たとえば、リクエストがサードパーティプロバイダーからの支払いを完了するものである場合）。
ステータスコード - 関連するエラー応答ステータスコード（400-599コード）。
メソッド - リクエストメソッド、最も一般的なHTTPメソッドは「GET」と「POST」です。GETはデータを取得し、POSTはデータを送信します。
ステータスコードを調査する
ステータスコードを読むことで、開発者はアプリケーションで何が起こっているかを迅速に確認し、エラーをすぐにチェックできます。
エラーには主に2つのカテゴリがあります：
-
クライアントエラー --- ステータス400から4xx
- エラーはブラウザ/ウェブアプリから送信された初期リクエストに由来し、間違いが含まれています。
- これらのエラーはより問題が多く、エラーはほとんどの場合コード自体に由来し、ページを再読み込みしたりリクエストを再送信しても問題は解決しません。
-
サーバーエラー --- ステータス500から5xx
エラーはサーバーによるリクエスト処理中に発生し、サーバーが内部エラーに遭遇し、リクエストを解決できないことを意味します。
- ほとんどのサーバーサイドエラーは一時的であり、ユーザーエージェントが後で同じリクエストを送信すると、ページを再読み込みすることでリクエストが成功する可能性があります。
最も一般的なステータスエラーコードとその意味
一般的なクライアントサイドエラー
コード |
メッセージ |
重要性 |
400 |
不正なリクエスト |
サーバーが無効な構文のためにAPIリクエストを処理できなかった: リクエストを構築する際のタイプミスや誤り、必要なクエリパラメータが欠落または無効、セミコロンやカンマが欠落した不正なJSONボディ... |
401 |
認証されていない |
APIリクエストに認証情報が欠落しているか、提供された認証情報が無効な場合に返されます |
403 |
禁止されています |
ユーザーが正しいアクセス許可でAPIアクセスのトークンを要求しなかった場合に返されます。 |
見つかりません |
リソースが見つかりません。意味は次のいずれかです:
|
|
408 |
リクエストタイムアウト |
ウェブサイトサーバーに送信されたリクエストが、ウェブサイトのサーバーが待機する準備ができている時間を超えた場合 |
413 |
リクエストエンティティが大きすぎる |
クライアントからのリクエストがウェブサーバーによって処理できるサイズを超えた場合に発生します |
429 |
リクエストが多すぎます |
多くの公共APIには、何らかの形のレート制限が含まれています。これは、ユーザーがあまりにも多くのAPI呼び出しを行うことからAPIプロバイダーを保護する方法であり、リソースを過剰に消費し、APIのクラッシュを引き起こす可能性があります。 |
一般的なサーバーサイドエラー
コード |
メッセージ |
重要性 |
500 |
内部サーバーエラー |
サーバーは、リクエストを満たすことを妨げる予期しない条件に遭遇しました。 |
502 |
バッドゲートウェイ または プロキシエラー |
サーバーは、ゲートウェイまたはプロキシとして動作している間、リクエストを満たすためにアクセスした上流サーバーから無効な応答を受け取りました。 |
503 |
サービス利用不可 |
サーバーは、現在、一時的な過負荷またはサーバーのメンテナンスのためにリクエストを処理できません。 |