プライマリアプリケーション内で実行される基本認証フロー
- トピック:
- 認証
Adobe Pass認証使用権内の 認証フロー により、ストリーミングアプリケーションはユーザーが有効なMVPD アカウントを持っていることを確認できます。 このプロセスを実行するには、MVPDのアクティブなアカウントを持ち、MVPDのログインページに有効なログイン資格情報を入力する必要があります。
次の場合は、認証フローが必要です。
- ユーザーが初めてアプリケーションを開いたとき。
- ユーザーの以前の認証が期限切れになった場合。
- ユーザーがMVPD アカウントからログアウトしたとき。
- ユーザーが別のMVPDで認証を行う場合。
これらの場合はすべて、プロファイルエンドポイントを呼び出すアプリケーションは、空の応答または 1 つ以上のプロファイル(ただし異なる MVPD の場合)を受け取ります。
認証フロー では、ユーザーエージェント(ブラウザー)が、アプリケーションからAdobe Pass バックエンド、次にMVPD ログインページ、最後にアプリケーションに一連の呼び出しを実行する必要があります。 このフローには、MVPD システムへのリダイレクトと、ドメインごとに保存される Cookie やセッションの管理が含まれる場合があります。これらは、ユーザーエージェントを使用せずに達成し、保護することが困難な場合があります。
ユーザーインタラクションをサポートしてMVPDを選択し、ユーザーエージェントで選択されたMVPDを使用して認証を行うプライマリアプリケーション(ストリーミングアプリケーション)の機能に基づいて、認証シナリオは次のようになります。
プライマリアプリケーション内での認証の実行
前提条件
プライマリアプリケーション内でユーザーインタラクションを通じて認証を実行する前に、次の前提条件が満たされていることを確認してください。
- ストリーミングアプリケーションは、MVPDを選択する必要があります。
- ストリーミングアプリケーションは、選択したMVPDでログインするための認証セッションを開始する必要があります。
- ストリーミングアプリケーションは、ユーザーエージェントで選択したMVPDを使用して認証する必要があります。
- ストリーミングアプリケーションは、MVPDを選択するためのユーザーインタラクションをサポートしています。
- ストリーミングアプリケーションは、ユーザーエージェント内の選択されたMVPDを使用して認証を行うユーザーインタラクションをサポートしています。
ワークフロー
次の図に示すように、プライマリ・アプリケーション内で実行される基本認証フローを実装するには、次の手順に従います。
プライマリアプリケーション内での認証の実行
-
認証セッションの作成: ストリーミングアプリケーションは、セッションエンドポイントを呼び出して認証セッションを開始するために必要なすべてのデータを収集します。
IMPORTANT
次について詳しくは、 認証セッションの作成API ドキュメントを参照してください。serviceProvider
、mvpd
、domainName
、redirectUrl
などのすべての 必須 パラメーターAuthorization
、AP-Device-Identifier
などのすべての 必須 ヘッダー- すべての オプション パラメーターおよびヘッダー
ストリーミングアプリケーションは、認証セッションを作成する際に、1 回の呼び出しで必要なすべてのパラメーターを指定する必要があります。 -
次のアクションを示す: セッションエンドポイント応答には、次のアクションに関するストリーミングアプリケーションのガイドに必要なデータが含まれています。
IMPORTANT
セッション応答で提供される情報について詳しくは、 認証セッションの作成API ドキュメントを参照してください。セッション エンドポイントは、基本的な条件が満たされていることを確認するために、リクエストデータを検証します。- required パラメーターおよびヘッダーは有効である必要があります。
- 指定した
serviceProvider
とmvpd
の統合はアクティブである必要があります。
検証に失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。 -
決定フローで続行: セッションエンドポイント応答には、次のデータが含まれます。
actionName
属性は「authorize」に設定されます。actionType
属性は「direct」に設定されます。
Adobe Pass バックエンドが有効なプロファイルを特定した場合、その後の決定フローに使用できるプロファイルが既に存在するので、ストリーミングアプリケーションは選択したMVPDで再認証する必要はありません。
-
ユーザーエージェントで URL を開く: セッションエンドポイントの応答には、次のデータが含まれます。
- MVPDのログインページ内でインタラクティブ認証を開始するために使用できる
url
。 actionName
属性は「authenticate」に設定されています。actionType
属性は「interactive」に設定されます。
Adobe Pass バックエンドが有効なプロファイルを識別できない場合、ストリーミングアプリケーションはユーザーエージェントを開いて指定されたプロファイ
url
を読み込み、Authenticate エンドポイントにリクエストを送信します。 このフローには、複数のリダイレクトが含まれる場合があり、最終的にユーザーがMVPDのログインページに移動して、有効な資格情報を提供します。 - MVPDのログインページ内でインタラクティブ認証を開始するために使用できる
-
MVPD認証の完了: 認証フローが正常に完了すると、ユーザーエージェントインタラクションは通常のプロファイルをAdobe Pass バックエンドに保存し、指定された
redirectUrl
に到達します。 -
特定のコードのプロファイルを取得: ストリーミングアプリケーションは、プロファイルエンドポイントにリクエストを送信することで、プロファイル情報を取得するために必要なすべてのデータを収集します。
IMPORTANT
次について詳しくは、 特定のコードのプロファイルの取得API ドキュメントを参照してください。serviceProvider
、code
などのすべての 必須 パラメーターAuthorization
、AP-Device-Identifier
などのすべての 必須 ヘッダー- すべての オプション パラメーターおよびヘッダー
TIP
ストリーミングアプリケーションは、ユーザーエージェントが指定されたredirectUrl
に到達して、通常のプロファイルが正常に生成および保存されたかどうかを確認するまで待つ必要があります。 -
通常のプロファイルに関する情報を返す: プロファイルエンドポイント応答には、受信したパラメーターとヘッダーに関連付けられた通常のプロファイルに関する情報が含まれます。
IMPORTANT
プロファイル応答で提供される情報について詳しくは、 特定のコードのプロファイルの取得API ドキュメントを参照してください。プロファイルエンドポイントは、基本条件が満たされていることを確認するために、リクエストデータを検証します。- required パラメーターおよびヘッダーは有効である必要があります。
検証に失敗した場合は、エラー応答が生成され、 拡張エラーコードドキュメントに従った追加情報が提供されます。