強化されたエラーコード enhanced-error-codes
拡張エラーコードは、以下に統合されたクライアントアプリケーションに追加のエラー情報を提供するAdobe Pass認証機能を表します。
-
Adobe Pass Authentication REST API:
-
Adobe Pass Authentication SDK Preauthorize API:
- (レガシー) JavaScript SDK (Preauthorize API)
- (レガシー) iOS/tvOS SDK (Preauthorize API)
- (レガシー) Android SDK (Preauthorize API)
(*)事前認証APIは、拡張エラーコードのサポートを提供する唯一のAdobe Pass Authentication SDK APIです。
表示域 enhanced-error-codes-representation
拡張エラーコードは、統合されたAdobe Pass Authentication APIと使用される「Accept」ヘッダー値(つまり、application/jsonまたはapplication/xml)に応じて、JSONまたはXML形式で表すことができます。
- トップレベルのエラー情報:この場合、"error" オブジェクトはトップレベルに配置されているため、応答本文には***"error"*** オブジェクトのみを含めることができます。
- アイテムレベルのエラー情報:この場合、"error" オブジェクトはアイテムレベルにあるため、応答本文には、サービス中にエラーが発生したすべてのアイテムに対する***"error"*** オブジェクトを含めることができます。
REST API v2
REST API v2に適用できるJSONとして表される拡張エラーコードの例を含む次のHTTP応答を参照してください。
| code language-json |
|---|
|
| code language-json |
|---|
|
REST API v1
REST API v1に適用できるJSONまたはXMLとして表される拡張エラーコードの例を含む次のHTTP応答を参照してください。
| code language-json |
|---|
|
| code language-json |
|---|
|
| code language-xml |
|---|
|
構造 enhanced-error-codes-representation-structure
拡張エラーコードには、次の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を提供する「コード」フィールドが含まれています。
「コード」フィールドの可能な値は、統合されたAdobe Pass Authentication APIに基づいて、2つのリストの以下に集約されます。
Lists enhanced-error-codes-lists
REST API v2 enhanced-error-codes-lists-rest-api-v2
次の表に、クライアントアプリケーションがAdobe Pass Authentication REST API v2と統合されたときに発生する可能性のある拡張エラーコードを示します。
(レガシー) REST API v1 enhanced-error-codes-lists-rest-api-v1
次の表に、クライアントアプリケーションがAdobe Pass Authentication REST API v1と統合されたときに発生する可能性のある拡張エラーコードを示します。
(レガシー) SDK Preauthorize API enhanced-error-codes-lists-sdks-preauthorize-api
クライアントアプリケーションがAdobe Pass Authentication SDK Preauthorize APIと統合されたときに発生する可能性のある拡張エラーコードについては、前の セクション を参照してください。
応答処理 enhanced-error-codes-response-handling
要約すると、拡張エラーコードを含む応答を処理する場合は、次の点を考慮する必要があります。
-
エラーを返すAPIに依存しない:拡張エラーコードの完全なカタログをサポートする一元化されたエラー処理ロジックを、APIが生成するかどうかに関係なく実装します。 いくつかの拡張エラーコードはAPI間で共有され、一貫して処理する必要があります。
-
トップレベルとアイテムレベルのエラー情報に依存しない:トップレベルとアイテムレベルのエラー情報を通信方法に依存しない方法で処理し、両方の形式の拡張エラーコードを送信できることを確認します。
-
両方のステータス値を確認する: HTTP応答のステータスコードと拡張エラーコードの「ステータス」フィールドの両方を常に確認します。 両者には違いがあり、どちらも貴重な情報です。
-
再試行ロジック:再試行が必要なエラーの場合、再試行が制限されているか(2-3など)、サーバーに負荷がかかるのを避けるために指数関数的なバックオフで行われていることを確認します。 また、複数の項目を一度に処理するAdobe Pass認証API (Preauthorize APIなど)の場合は、繰り返しリクエストに「再試行」とマークされた項目のみを含め、リスト全体を含める必要はありません。
-
構成の変更:構成の変更が必要なエラーについては、新しいアプリケーションまたは新機能を起動する前に、必要な変更を行ってください。
-
認証と認証:認証と認証に関連するエラーの場合、必要に応じてユーザーに再認証を促すか、新しい認証を取得する必要があります。
-
ユーザーからのフィードバック:オプションで、人間が読み取れる「メッセージ」フィールドと(潜在的な)「詳細」フィールドを使用して、問題についてユーザーに通知します。 「詳細」テキストメッセージは、MVPDの事前認証エンドポイントまたは認証エンドポイントから、または劣化ルールを適用する際にプログラマーから渡される可能性があります。