特定のコードのプロファイルの取得 retrieve-profile-for-specific-code

IMPORTANT
このページのコンテンツは、情報提供のみを目的として提供されています。 このAPIを使用するには、Adobeの現在のライセンスが必要です。 無断使用は認められません。
IMPORTANT
REST API V2の実装は、​ スロットル メカニズム ​のドキュメントによって制限されています。

リクエスト request

HTTP
パス
/api/v2/{serviceProvider}/profiles/code/{code}
メソッド
GET
パスパラメーター
serviceProvider
オンボーディングプロセス中にサービスプロバイダーに関連付けられた内部一意のID。
必須
コード
ストリーミングデバイスで認証セッションを作成した後に取得された認証コード。
必須
ヘッダー
認証
ベアラートークンのペイロードの生成については、Authorization ヘッダーのドキュメントを参照してください。
必須
X-Forwarded-For
ストリーミングデバイスのIP アドレス。

特に、ストリーミングデバイスではなくプログラマーサービスによって呼び出しが行われる場合は、サーバーからサーバーへの実装に常に使用することを強くお勧めします。

クライアントからサーバーへの実装では、ストリーミングデバイスのIP アドレスが暗黙的に送信されます。
オプション
AP-TempPass-Identity
ユーザーの一意のID ペイロードの生成については、AP-TempPass-Identity ヘッダーのドキュメントを参照してください。
オプション
AP-Visitor-Identifier
訪問者識別子ペイロードの生成については、AP-Visitor-Identifier ヘッダーのドキュメントを参照してください。
オプション
承認
クライアントアプリケーションが受け入れたメディアタイプ。

指定する場合は、application/json;charset=utf-8である必要があります。
オプション
User-Agent
クライアントアプリケーションのユーザーエージェント。
オプション

応答 response

コード
テキスト
説明
200
OK
応答本文には、有効なプロファイルのマップが含まれています。空の場合があります。
400
不正なリクエスト
リクエストが無効です。クライアントはリクエストを修正して、もう一度試す必要があります。 応答本文には、拡張エラーコードのドキュメントに準拠するエラー情報が含まれる場合があります。
401
未承認
アクセストークンが無効です。クライアントは新しいアクセストークンを取得し、再試行する必要があります。 詳しくは、動的クライアント登録の概要のドキュメントを参照してください。
403
禁止
一時的なアクセスの有効期間(TTL)が期限切れになっているか、リソースの最大数を超えています。通常のMVPDを使用して基本認証フローを開始するようにユーザーに指示する必要があります。 応答本文には、拡張エラーコードのドキュメントに準拠するエラー情報が含まれる場合があります。
405
メソッドは許可されていません
HTTP メソッドが無効です。クライアントは、リクエストされたリソースに対して許可されているHTTP メソッドを使用して、再試行する必要があります。 詳しくは、「 リクエスト」の節を参照してください。
500
内部サーバーエラー
サーバーサイドで問題が発生しました。 応答本文には、拡張エラーコードのドキュメントに準拠するエラー情報が含まれる場合があります。

成功 success

ヘッダー
ステータス
200
必須
コンテンツタイプ
アプリケーション/json
必須
本文
プロファイル

キー、値のペアのマップを含むJSON。

キー要素は、次の値で定義されます。

table 0-row-3 1-row-3 1-bgcolor-#eff2f7 2-bgcolor-#eff2f7 3-bgcolor-#eff2f7 5-bgcolor-#deebff layout-auto html-authored
値
mvpd オンボーディングプロセス中にID プロバイダーに関連付けられた内部一意のID。 必須

value エレメントは、次の属性で定義されます。

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 1-bgcolor-#eff2f7 2-bgcolor-#eff2f7 3-bgcolor-#eff2f7 5-bgcolor-#deebff 9-bgcolor-#deebff 13-bgcolor-#deebff 17-bgcolor-#deebff 21-bgcolor-#deebff layout-auto html-authored
属性
notBefore プロファイルが無効になるまでのタイムスタンプ(ミリ秒単位)。 必須
notAfter プロファイルが無効になるまでのタイムスタンプ(ミリ秒単位)。 必須
イシュア

プロファイルを所有するエンティティ。

使用可能な値は次のとおりです。

  • mvpd (Spectrum、Cablevisionなど)
    プロファイルは次の結果として作成されました:基本認証。
  • Adobe
    次の結果としてプロファイルが作成されました:アクセスが低下しました。一時的なアクセス。
必須
タイプ

プロファイルのタイプ。

使用可能な値は次のとおりです。

  • regular
    プロファイルは次の結果として作成されました:基本認証。
  • degraded
    次の結果としてプロファイルが作成されました:アクセスが低下しました。
  • 一時
    次の結果としてプロファイルが作成されました:一時アクセス。
必須
属性

キー、値のペアのマップを含むJSON。

キー要素は、ユーザーのメタデータ属性によって定義され、次の要素を使用できます。

  • 「userID」などの必須
  • 「zip」、「householdID」、「maxRating」など、必須ではないエレメント。

属性の値は次のとおりです。

  • シンプル
  • リスト
  • マップ

認証フローが完了すると、ユーザーメタデータが使用できるようになります。ただし、MVPDと特定のメタデータ属性に応じて、認証フロー中に特定のメタデータ属性が更新される場合があります。

必須
必須

エラー error

ヘッダー
ステータス
400, 401, 403, 405, 500
必須
コンテンツタイプ
アプリケーション/json
必須
本文

応答本文は、拡張エラーコードドキュメントに準拠する追加のエラー情報を提供する場合があります。

クライアントアプリケーションは、このAPIによって最も一般的に返されるエラーコードを適切に処理できるエラー処理メカニズムを実装する必要があります。

  • invalid_authentication_session
  • invalid_parameter_code
  • など。

上記のリストは網羅的ではありません。 クライアントアプリケーションは、公開ドキュメントで定義されているすべての強化エラーコードを処理できる必要があります。

必須

サンプル samples

​1. 基本認証を通じて取得した特定のコードのプロファイルの取得

リクエスト
code language-https
GET /api/v2/REF30/profiles/code/XTC98W HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
応答
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "profiles": {
        "Cablevision": {
            "notBefore": 1752149281000,
            "notAfter": 1783685280000,
            "issuer": "Cablevision",
            "type": "regular",
            "attributes": {
                "userID": {
                    "value": "BASE64_value_userId",
                    "state": "plain"
                },
                "householdID": {
                    "value": "BASE64_value_householdId",
                    "state": "plain"
                },
                "zip": {
                    "value": "BASE64_value_zip",
                    "state": "enc"
                }
            }
        }
     }
}

​2. 基本TempPassが選択されている間に、特定のコードのプロファイルを取得します

リクエスト
code language-https
GET /api/v2/REF30/profiles/code/XTC98W HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
応答 – 使用可能
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "profiles": {
        "TempPass_TEST40": {
            "notBefore": 1697718650206,
            "notAfter": 1697718710206,
            "issuer": "Adobe",
            "type": "temporary",
            "attributes": {
                "expiration_date": {
                    "value": 1697718710206,
                    "state": "plain"
                },
                "userID": {
                    "value": "temppass_0bdf451aa9c8fa60e80f6b99ab48310c73b480f1",
                    "state": "plain"
                }
            }
        }
    }
}
応答 – 期間制限を超えました
code language-https
HTTP/1.1 403 Forbidden

Content-Type: application/json;charset=UTF-8

{
    "status": 403,
    "code": "temporary_access_duration_limit_exceeded",
    "message": "The temporary access duration limit has been exceeded.",
    "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=ja",
    "action": "authentication"
}
応答 – 無効な設定
code language-https
HTTP/1.1 500 Internal Server Error

Content-Type: application/json;charset=UTF-8

{
    "status": 500,
    "code": "invalid_configuration_temporary_access",
    "message": "The temporary access configuration is invalid.",
    "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=ja",
    "action": "configuration"
}

​3. プロモーション TempPassが選択されている間、特定のコードのプロファイルを取得します

リクエスト
code language-https
GET /api/v2/REF30/profiles/code/XTC98W HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    AP-TempPass-Identity: eyJlbWFpbCI6ImZvb0BiYXIuY29tIn0=
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
応答 – 使用可能
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "profiles": {
        "flexibleTempPass": {
            "notBefore": 1697720528524,
            "notAfter": 1697720588524,
            "issuer": "Adobe",
            "type": "temporary",
            "attributes": {
                "remaining_resources": {
                    "value": 1,
                    "state": "plain"
                },
                "used_assets": {
                    "value": [
                        "res04",
                        "res02",
                        "res03",
                        "res01"
                    ],
                    "state": "plain"
                },
                "expiration_date": {
                    "value": 1697720528524,
                    "state": "plain"
                },
                "userID": {
                    "value": "temppass_0bdf451aa9c8fa60e80f6b99ab48310c73b480f1",
                    "state": "plain"
                }
            }
        }
    }
}
応答 – 期間制限を超えました
code language-https
HTTP/1.1 403 Forbidden

Content-Type: application/json;charset=UTF-8

{
    "status": 403,
    "code": "temporary_access_duration_limit_exceeded",
    "message": "The temporary access duration limit has been exceeded.",
    "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=ja",
    "action": "authentication"
}
応答 – リソースの上限を超えました
code language-https
HTTP/1.1 403 Forbidden

Content-Type: application/json;charset=UTF-8

{
    "status": 403,
    "code": "temporary_access_resources_limit_exceeded",
    "message": "The temporary access resources limit has been exceeded.",
    "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=ja",
    "action": "authentication"
}
応答 – 無効な設定
code language-https
HTTP/1.1 500 Internal Server Error

Content-Type: application/json;charset=UTF-8

{
    "status": 500,
    "code": "invalid_configuration_temporary_access",
    "message": "The temporary access configuration is invalid.",
    "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=ja",
    "action": "configuration"
}
応答 – 無効なID
code language-https
HTTP/1.1 400 Bad Request

Content-Type: application/json;charset=UTF-8

{
    "status": 400,
    "code": "invalid_header_identity_for_temporary_access",
    "message": "The identity for temporary access header value is missing or invalid.",
    "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=ja",
    "action": "none"
}

​4. 劣化が適用されている間に、特定のコードのプロファイルを取得する

リクエスト
code language-https
GET /api/v2/REF30/profiles/code/XTC98W HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
応答 – AuthNAllの低下
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "profiles": {
        "${degradedMvpd}": {
            "notBefore": 1697719042666,
            "notAfter": 1697719102666,
            "issuer": "Adobe",
            "type": "degraded",
            "attributes":
                "userID": {
                    "value": "95cf93bcd183214a0bdf451aa9c8fa60e80f6b99ab48310c73b480f1",
                    "state": "plain"
                }
            }
        }
    }
}
note important
IMPORTANT
95cf93bcd183214aは劣化固有のプレフィックスです。
recommendation-more-help
pass-help-authentication