デバイス管理(クライアント側)

デバイス管理を使用すると、より多くの制御が可能になり、顧客様によるデバイス管理が可能になります。 このセクションでは、デバイス登録と再生スロットの予約のエンドツーエンドの例、およびユーザーケースについて説明します。

説明

以下の図は、デバイス管理の実装を示しています。このユーザージャーニーの一部として、ユーザーのデバイスが登録され、管理できるようになります。ユーザーの登録・認証はこのフローではカバーされていません。これに関するAPIワークフローの詳細は、登録セクションでご説明します。

デバイス管理の詳細、およびeSuite HQでの設定方法については、モジュールガイドをご覧ください。更に、アカウント管理で他の関連するワークフローを利用できます。

ワークフロー

エンドツーエンドのデバイスおよびスロット登録

デバイス登録の失敗

スロット予約の失敗

認証

これらはクライアント側によるAPIのコールであるため、APIにはクライアント側の認証が使用されます。 API認証方法の詳細については、こちらをご覧ください:https://supportstaging.mppglobal.com/technical/esuite-rest-api-support/authenticating/

eSuite認証の前提条件

クライアント側アプリケーションがeSuiteクライアント側APIを呼び出すことができるようにするには、MPP Globalに以下を提供する必要があります:
  • Originsのリスト
eSuite MPP Global内で提供および登録されると、以下が提供されます:
  • Token ID
これらの設定は、環境によって異なるため、UAT環境と本番環境の両方に提供する必要があります。

API ドキュメント

上記で使用されるAPIの詳細を以下に説明します。デバイス管理はRESTバージョン11.0.0からのみ利用可能です。

アカウントデバイスポリシーの取得

このAPIは、「許可されたデバイス」や「許可されたデバイス変更」などの高レベルのデバイスポリシー情報と、予約されたスロット情報を含むすべての登録済みデバイスの詳細を取得します。

デバイス管理は、グローバルレベルまたはアカウントレベルの2つの方法で制御できます。このエンドポイントからポリシー参照を取得する場合、devicePolicyReferenceフィールドを常に使用する必要があります。親ポリシー参照(デバイスポリシーがアカウントレベルで設定されている場合にのみ返されます)は情報目的で返されます。

このAPIの詳細については、こちらをご覧ください。

デバイスの登録

「アカウントデバイスポリシーの取得」応答に基づいて、問題のデバイスがまだ存在しないことが判明した場合、このエンドポイントを使用してデバイスを登録する必要があります。作成されると、Device ReferenceはLocation応答ヘッダーの一部として返されます。参照の長さは18文字で、返されたURLの末尾にあります。以下に例を示します。

https://{restHost}/api/accounts/{accountReference}/device-policies/{devicePolicyReference}/devices/{deviceReference}

このAPIの詳細については、こちらをご覧ください。

スロットの登録

デバイスが登録されたら、ユーザーがコンテンツ確認するために、再生スロットを登録する必要があります。 deviceReferenceを使用すると、このエンドポイントを使用してスロットを予約できます。作成されると、Location Referenceヘッダーの一部としてSlot Referenceが返されます。参照の長さは18文字で、返されたURLの末尾にあります。以下に例を示します

https://{restHost}/api/accounts/{accountReference}/device-policies/{devicePolicyReference}/devices/{deviceReference}/slots/{slotReference}

このAPIの詳細については、こちらをご覧ください。

スロットのリリース

このエンドポイントは、アカウントデバイスに登録されたスロットをリリースします。これを使用できる例は、ユーザーがログアウトしたとき、または一定期間アクティブでないときです。

このAPIの詳細については、こちらをご覧ください。