ドキュメントAdobe PassAdobe Pass 認証

登録ページ registration-page

Last update: Wed Mar 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

REST API エンドポイント clientless-endpoints

NOTE
このページのコンテンツは、情報提供の目的でのみ提供されます。 この API を使用するには、Adobeの現在のライセンスが必要です。 不正な使用は許可されていません。
NOTE
REST API 実装は、 スロットルメカニズム

<reggie_fqdn>:

<sp_fqdn>:

説明 create-reg-code-svc

ランダムに生成された登録コードとログインページの URI を返します。

エンドポイント
呼び出し済み
作成者
入力
パラメーター
HTTP
メソッド
応答
HTTP
応答
<reggie_fqdn>/reggie/v1/{requestor}/regcode
例：
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode
ストリーミングアプリ
または
プログラマーサービス
(1) 請求者
（パスコンポーネント）
2. deviceId （ハッシュ化）
（必須）
3. device_info/X-Device-Info （必須）
4. mvpd （オプション）
5. ttl （オプション）
6. deviceType
7. deviceUser （廃止）
8. appId （廃止）
POST
登録コードと情報、またはエラーの詳細を含む XML または JSON が失敗した場合。 以下のスキーマとサンプルを参照してください。
201
入力パラメーター
説明
要求者
この操作が有効な ProgrammerRequestorId。
deviceId
デバイス ID バイト。
device_info/
X-Device-Info
デバイス情報のストリーミング。
注意：この INFO は、URL パラメーターとして渡すことができますが、このパラメーターの潜在的なサイズとGETURL の長さの制限により、HTTP ヘッダーで X-Device-Info として渡す必要があります。
詳しくは、 デバイスと接続情報を渡す.
mvpd
この操作が有効な MVPD ID です。
ttl
この regcode の有効期間（秒）。
注意:ttl の最大値は36000秒（10 時間）です。 値が大きいと、400 HTTP 応答が発生します（無効なリクエストです）。 次の場合 ttl が空の場合、Adobe Pass Authentication はデフォルト値の 30 分を設定します。
deviceType
デバイスタイプ（Roku、PC など）。
このパラメータが正しく設定されている場合、ESM は以下の指標を提供します。 デバイスタイプ別に分類 クライアントレスを使用する場合に、Roku、AppleTV、Xbox など、様々な種類の分析を実行できます。
詳しくは、 パス指標でクライアントレスデバイスタイプパラメーターを使用するメリット​
注意:device_info がこのパラメーターを置き換えます。
deviceUser
デバイスのユーザー ID。
appId
アプリケーション ID/名前。
注意:device_info がこのパラメーターを置き換えます。
CAUTION
ストリーミングデバイスの IP アドレス


クライアント/サーバ間実装の場合、ストリーミングデバイスの IP アドレスはこの呼び出しで暗黙的に送信されます。 サーバー間実装の場合、 regcode の呼び出しは、ストリーミングデバイスではなく、プログラマーサービスになります。ストリーミングデバイスの IP アドレスを渡すには、次のヘッダーが必要です。
code language-none 
X-Forwarded-For : <streaming_device_ip>
場所 <streaming\_device\_ip> は、ストリーミングデバイスのパブリック IP アドレスです。



例：
code language-none 
POST /reggie/v1/{req_id}/regcode HTTP/1.1</br>X-Forwarded-For:203.45.101.20

応答 XML スキーマ xml-schema

登録コード XSD registration-code-xsd

    <?xml version="1.0" encoding="UTF-8"?>
    <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="model.mvc.reggie.pass.adobe.com"
            targetNamespace="model.mvc.reggie.pass.adobe.com"
            attributeFormDefault="unqualified"
            elementFormDefault="unqualified">
        <xs:element name="regcode">
            <xs:complexType>
                <xs:all>
                    <xs:element name="id" type="xs:string" />
                    <xs:element name="code" type="xs:string" />
                    <xs:element name="requestor" type="xs:string" minOccurs="1" maxOccurs="1"/>
                    <xs:element name="mvpd" type="xs:string" minOccurs="1" maxOccurs="1"/
                    <xs:element name="generated" type="xs:long" />
                    <xs:element name="expires" type="xs:long" />
                    <xs:element name="info" type="infoType" maxOccurs="1"/>
                </xs:all>
            </xs:complexType>
        </xs:element>
        <xs:complexType name="infoType">
            <xs:all>
                <xs:element name="deviceId" type="xs:base64Binary" minOccurs="1" maxOccurs="1"/>
                <xs:element name="deviceType" type="xs:string" minOccurs="0" maxOccurs="1"/>
                <xs:element name="deviceUser" type="xs:string" minOccurs="0" maxOccurs="1"/>
                <xs:element name="appId" type="xs:string" minOccurs="0" maxOccurs="1"/>
                <xs:element name="appVersion" type="xs:string" minOccurs="0" maxOccurs="1"/>
                <xs:element name="registrationURL" type="xs:anyURI" minOccurs="0" maxOccurs="1"/>
            </xs:all>
        </xs:complexType>
    </xs:schema>
エレメント名
説明
id
登録コードサービスで生成された UUID
コード
登録コードサービスによって生成された登録コード
要求者
要求者 ID
mvpd
Mvpd ID
生成済み
登録コード作成タイムスタンプ (1970 年 1 月 1 日 (GMT) からのミリ秒単位 )
有効期限
登録コードの有効期限が切れたときのタイムスタンプ (1970 年 1 月 1 日 (GMT) からのミリ秒単位 )
deviceId
一意のデバイス ID（または XSTS トークン）
deviceType
デバイスタイプ
deviceUser
デバイスにログインしたユーザー
appId
アプリケーション ID
appVersion
アプリケーションのバージョン
registrationURL
エンドユーザーに表示されるログイン Web アプリの URL

エラーメッセージ XSD error-message

    <?xml version="1.0" encoding="UTF-8"?>
    <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="rest.pass.adobe.com"
               targetNamespace="rest.pass.adobe.com"
               attributeFormDefault="unqualified"
               elementFormDefault="unqualified">
        <xs:element name="error">
            <xs:complexType>
                <xs:all>
                    <xs:element name="status" type="xs:int" minOccurs="1" maxOccurs="1"/>
                    <xs:element name="message" type="xs:string" minOccurs="1" maxOccurs="1"/>
                    <xs:element name="details" type="xs:string" minOccurs="0" maxOccurs="1"/>
                </xs:all>
            </xs:complexType>
        </xs:element>
    </xs:schema>

レスポンスのサンプル sample-response

XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ns2:regcode xmlns:ns2="model.mvc.reggie.pass.adobe.com">
        <id>678f9fea-a1cafec8-1ff0-4a26-8564-f6cd020acf13</id>
        <code>TJJCFK</code>
        <requestor>sampleRequestorId</requestor>
        <mvpd>sampleMvpdId</mvpd>
        <generated>1348039846647</generated>
        <expires>1348043446647</expires>
        <info>
            <deviceId>dGhpc0lkQUR1bW15RGV2aWNlSWQ=</deviceId>
            <deviceType>xbox</deviceType>
            <deviceUser>JD</deviceUser>
            <appId>2345</appId>
            <appVersion>2.0</appVersion>
            <registrationURL>http://loginwebapp.com</registrationURL>
        </info>
    </ns2:regcode>

JSON:

    {
        "id": "678f9fea-9d364b29-246c-488f-b97e-298566d1b9e0",
        "code": "D4BDU2W",
        "requestor": "sampleRequestorId",
        "mvpd": "sampleMvpdId",
        "generated": 1348039555877,
        "expires": 1348043155877,
        "info": {
            "deviceId": "dGhpc0l.kQUR1bW15RGV2.aWNlSWQ=",
            "deviceType": "xboxOne",
            "deviceUser": "JD",
            "appId": "2345",
            "appVersion": "2.0",
            "registrationURL": "http://loginwebapp.com"
        }
    }
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b