拡張エラーコード enhanced-error-codes
拡張エラーコードは、Adobe Passの認証機能を表し、と統合されたクライアントアプリケーションに追加のエラー情報を提供します。
-
Adobe Pass認証 REST API:
-
Adobe Pass認証 SDK による API の事前認証:
(*) Preauthorize API は、拡張エラーコードのサポートを提供する唯一のAdobe Pass Authentication SDK API です。
表示域 enhanced-error-codes-representation
拡張エラーコードは、統合Adobe Pass認証 API と使用されている「Accept」ヘッダー値(application/json
または application/xml
)に応じて、JSON
形式または XML
形式で表すことができます。
- 最上位レベルのエラー情報:この場合、"error" オブジェクトは最上位レベルにあるので、応答本文には "error" オブジェクトのみを含めることができます。
- 項目レベルのエラー情報:この場合、"error" オブジェクトは項目レベルにあるので、応答本文には、サービス中にエラーが発生したすべての項目の "error" オブジェクトを含めることができます。
JSON
または XML
で表された拡張エラーコードを含む次の HTTP 応答の例を参照してください。
code language-json |
---|
|
code language-xml |
---|
|
code language-json |
---|
|
code language-json |
---|
|
code language-json |
---|
|
拡張エラーコードには、次の JSON
フィールドまたは XML
属性が含まれます。
サービスパートナーがカスタムメッセージを提供しない場合、このフィールドは存在しない可能性があります。
このフィールドには絶対 URL が格納されます。エラーコードから推論しないでください。エラーコンテキストに応じて、別の URL を指定できます。
アクション enhanced-error-codes-representation-action
拡張エラーコードには、状況を修正する可能性のある推奨アクションを提供する「アクション」フィールドが含まれています。
「アクション」フィールドには、次の値を使用できます。
(*)エラーによっては、複数のアクションが解決策になる場合がありますが、「アクション」フィールドは、エラーを修正する可能性が最も高いアクションを示します。
ステータス enhanced-error-codes-representation-status
拡張エラーコードには、エラーに関連付けられた HTTP ステータスコードを示す「ステータス」フィールドが含まれます。
「ステータス」フィールドに指定可能な値は次のとおりです。
「ステータス」が 4xx の拡張エラーコードは、通常、エラーがクライアントによって生成された場合に表示され、ほとんどの場合、クライアントがそれを修正するために追加の作業を必要とすることを意味します。
通常、5xx の「ステータス」を含む拡張エラーコードは、サーバーによってエラーが生成されたときに表示され、ほとんどの場合、サーバーがそれを修正するために追加の作業を必要とすることを意味します。
コード enhanced-error-codes-representation-code
拡張エラーコードには、エラーに関連付けられたAdobe Pass認証の一意の ID を提供する「コード」フィールドが含まれています。
「code」フィールドに指定可能な値は、統合Adobe Pass認証 API に基づいて 以下2 つのリストに集約されます。
リスト enhanced-error-codes-lists
REST API v1 enhanced-error-codes-lists-rest-api-v1
次の表に、Adobe Pass認証 REST API v1 と統合した場合にクライアントアプリケーションで発生する可能性のある拡張エラーコードを示します。
SDK 事前認証 API enhanced-error-codes-lists-sdks-preauthorize-api
Adobe Pass Authentication SDK の事前認証 API と統合した場合にクライアントアプリケーションで発生する可能性のある拡張エラーコードについては、前の 節を参照してください。
REST API v2 enhanced-error-codes-lists-rest-api-v2
次の表に、Adobe Pass Authentication REST API v2 と統合した場合にクライアントアプリケーションで発生する可能性のある拡張エラーコードを示します。
応答処理 enhanced-error-codes-response-handling
要約すると、拡張エラーコードを含む応答を処理する場合は、次の点を考慮する必要があります。
-
両方のステータス値を確認:常に、HTTP 応答のステータスコードと拡張エラーコードの「ステータス」フィールドの両方を確認します。 これらは異なる場合があり、どちらも貴重な情報を提供します。
-
トップレベルと項目レベルのエラー情報に依存しない:トップレベルおよび項目レベルのエラー情報を通信方法に依存せずに処理し、拡張エラーコードの両方の送信形式を確実に処理します。
-
再試行ロジック:再試行が必要なエラーの場合は、サーバーが圧倒されるのを避けるために、再試行が指数バックオフで行われることを確認します。 また、複数の項目を一度に処理するAdobe Pass Authentication API の場合(例:事前認証 API)、繰り返しリクエストには、リスト全体ではなく、「再試行」とマークされた項目のみを含める必要があります。
-
設定の変更:設定の変更が必要なエラーの場合は、新しいアプリケーションまたは新機能を起動する前に、必要な変更が行われていることを確認します。
-
認証と承認:認証と承認に関連するエラーの場合、必要に応じて、再認証を行うか新しい承認を取得するようにユーザーに促す必要があります。
-
ユーザーのフィードバック:任意。人間が判読できる「メッセージ」フィールドと(潜在的な)「詳細」フィールドを使用して、問題についてユーザーに通知します。 「詳細」テキスト メッセージは、MVPD 事前認証または認証エンドポイントから、または劣化ルールを適用する際にプログラマから渡される場合があります。