DokumentationAdobe PassAdobe Pass-Authentifizierung

Apple SSO-Cookbook (REST API v2) apple-sso-cookbook-rest-api-v2

Last update: Mon Apr 07 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
Der Inhalt dieser Seite dient nur zu Informationszwecken. Die Verwendung dieser API erfordert eine aktuelle Lizenz von Adobe. Eine unbefugte Nutzung ist nicht zulässig.

Die Adobe Pass-Authentifizierungs-REST-API V2 unterstützt das Partner Single Sign-On (SSO) für Endbenutzer von Client-Anwendungen, die auf iOS, iPadOS oder tvOS ausgeführt werden.

Dieses Dokument dient als Erweiterung für die vorhandene REST API V2 - Übersicht, die eine allgemeine Ansicht bietet, sowie für das Dokument, in dem die Implementierung von Single Sign-on mithilfe von Partnerflüssen beschrieben wird.

Apple-Single-Sign-on mit Partnerflüssen cookbook

Voraussetzungen prerequisites

Bevor Sie mit der einmaligen Anmeldung für Apple mithilfe von Partnerflüssen fortfahren, stellen Sie sicher, dass die folgenden Voraussetzungen erfüllt sind:

  • Die Streaming-Anwendung muss alle erforderlichen Daten für die X-Device-Info- und/oder User-Agent-Header erfassen, damit das Backend für die Adobe Pass-Authentifizierung die Geräteplattform und ihre Funktionen identifizieren kann. Weitere Informationen zu X-Device-Info Kopfzeile finden Sie in der Dokumentation X-Device-Info.

  • Die Streaming-Anwendung muss Zugriff auf die auf Geräteebene gespeicherten Abonnementinformationen des Benutzers anfordern, für die der Benutzer der Anwendung die Berechtigung zum Fortfahren erteilen muss, ähnlich wie das Gewähren von Zugriff auf die Kamera oder das Mikrofon des Geräts. Diese Berechtigung muss pro Anwendung über das Apple-Video-Abonnementkonto-Framework angefordert werden und das Gerät speichert die Benutzerauswahl.

    Wir empfehlen, Benutzern, die sich weigern, Berechtigungen für den Zugriff auf Abonnementinformationen zu erteilen, einen Anreiz zu bieten, indem sie die Vorteile des Apple Single Sign-on-Benutzererlebnisses erläutern. Sie sollten jedoch beachten, dass die Benutzenden ihre Entscheidung ändern können, indem sie zu den Anwendungseinstellungen gehen (Zugriff auf TV-Anbieter) oder auf iOS und iPadOS oder Settings -> Accounts -> TV Provider auf tvOS Settings -> TV Provider.

    Die Streaming-Anwendung kann die Berechtigung des Benutzers anfordern, wenn die Anwendung in den Vordergrundzustand wechselt, da die Anwendung die Abonnementinformationen des Benutzers jederzeit auf Zugriffsberechtigung überprüfen kann, bevor eine Benutzerauthentifizierung erforderlich wird.

IMPORTANT
Annahmen
  • Die Streaming-Anwendung hat die Onboarding-Voraussetzungen erfüllt, die für Programmierer gelten und für die Aktivierung des Apple Single Sign-on-Benutzererlebnisses erforderlich sind.

Workflow workflow

Führen Sie die angegebenen Schritte aus, um das Apple-Single Sign-on mithilfe von Partnerflüssen zu implementieren, wie im folgenden Diagramm dargestellt.

Apple-Single-Sign-on mit Partnerflüssen

Apple-Single-Sign-on mit Partnerflüssen

a. Registrierungsphase

  1. Abrufen von Client-Anmeldeinformationen: Die Streaming-Anwendung sammelt alle erforderlichen Daten, um die Client-Anmeldeinformationen abzurufen, indem sie den Endpunkt „Client Register“ aufruft.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden Themen finden in der APIDokumentation zum Abrufen von Client-Anmeldeinformationen:
    • Alle erforderlichen Parameter wie software_statement
    • Alle erforderlichen Kopfzeilen wie Content-Type, X-Device-Info
    • Alle optionalen Parameter und Kopfzeilen

  2. Client-Anmeldeinformationen zurückgeben: Die Antwort des Client Register-Endpunkts enthält Informationen zu den Client-Anmeldeinformationen, die mit den empfangenen Parametern und Headern verknüpft sind.

    note important
    IMPORTANT
    Weitere Informationen zu den in einer Antwort zum Abrufen von ClientAnmeldeinformationen finden Sie in der API-Dokumentation.
    Das Client-Register validiert die Anfragedaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:
    • Die erforderlichen Parameter und Kopfzeilen müssen gültig sein.
    Wenn die Validierung fehlschlägt, wird eine Fehlerantwort generiert, die zusätzliche Informationen entsprechend der API-Dokumentation Client-Anmeldeinformationen abrufen bereitstellt.
    note tip
    TIP
    Die Client-Anmeldeinformationen müssen zwischengespeichert und unbegrenzt verwendet werden.

  3. Zugriffs-Token abrufen: Die Streaming-Anwendung erfasst alle erforderlichen Daten, um das Zugriffs-Token abzurufen, indem sie den Client-Token-Endpunkt aufruft.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden Themen finden in der APIDokumentation zum Abrufen von Zugriffstoken:
    • Alle erforderlichen Parameter wie client_id, client_secret und grant_type
    • Alle erforderlichen Kopfzeilen wie Content-Type, X-Device-Info
    • Alle optionalen Parameter und Kopfzeilen

  4. Zugriffs-Token zurückgeben: Die Antwort des Client-Token-Endpunkts enthält Informationen zum Zugriffs-Token, das mit den empfangenen Parametern und Kopfzeilen verknüpft ist.

    note important
    IMPORTANT
    Weitere Informationen zu den in einer Zugriffstoken-Antwort bereitgestellten Informationen findenin der API-Dokumentation zum Abrufen von Zugriffstoken .
    Das Client-Token validiert die Anfragedaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:
    • Die erforderlichen Parameter und Kopfzeilen müssen gültig sein.
    Wenn die Validierung fehlschlägt, wird eine Fehlerantwort generiert, die zusätzliche Informationen entsprechend der API-Dokumentation Zugriffstoken abrufen bereitstellt.
    note tip
    TIP
    Das Zugriffstoken muss im Cache gespeichert und nur innerhalb der angegebenen Dauer verwendet werden (z. B. 24-Stunden-Time-to-Live). Nach Ablauf muss die Streaming-Anwendung ein neues Zugriffstoken anfordern.
B. Authentifizierungsphase überprüfen

  1. Apple Partner-Framework-Status abrufen: Die Streaming-Anwendung ruft das von entwickelte Video Subscriber Account Framework auf, um Benutzerberechtigungen und Anbieterinformationen abzurufen.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden finden Sie in der DokumentationVideo Subscriber Account Framework):
    • Die Streaming-Anwendung muss die Abonnementinformationen des Benutzers auf Zugriffsberechtigung überprüfen und nur fortfahren, wenn der Benutzer dies erlaubt hat.
    • Die Streaming-Anwendung muss einen Delegaten für die VSAccountManager bereitstellen.
    • Die Streaming-Anwendung muss eine Anfrage für Abonnentenkontoinformationen senden.
    • Die Streaming-Anwendung muss warten und die Metadaten verarbeiten.
    Die Streaming-Anwendung muss sicherstellen, dass sie einen booleschen Wert angibt, der false für die isInterruptionAllowed-Eigenschaft im VSAccountMetadataRequest-Objekt entspricht, um anzugeben, dass der Benutzer in dieser Phase nicht unterbrochen werden kann.

  2. Partner-Framework-Statusinformationen zurückgeben: Die Streaming-Anwendung validiert die Antwortdaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:

    • Der Benutzerberechtigungs-Zugriffsstatus wird gewährt.
    • Die Kennung der Benutzeranbieter-Zuordnung ist vorhanden und gültig.
    • Das Ablaufdatum des Benutzeranbieterprofils (falls verfügbar) ist gültig.

  3. Profile abrufen: Die Streaming-Anwendung sammelt alle erforderlichen Daten, um alle Profilinformationen abzurufen, indem eine Anfrage an den Endpunkt „Profiles“ gesendet wird.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden Themen finden in der APIDokumentation zum Abrufen von Profilen:
    • Alle erforderlichen Parameter wie serviceProvider
    • Alle erforderlichen Kopfzeilen wie Authorization, AP-Device-Identifier und AP-Partner-Framework-Status
    • Alle optionalen Parameter und Kopfzeilen
    Die Streaming-Anwendung muss sicherstellen, dass sie einen gültigen Wert für den Partner-Framework-Status enthält, sodass die abgerufene Antwort ein Profil vom Typ „appleSSO“ enthalten kann.
    Weitere Informationen zu AP-Partner-Framework-Status Kopfzeile finden Sie in der Dokumentation AP-Partner-Framework-Status.

  4. Rückgabe von Informationen zu gefundenen Profilen: Die Antwort des Endpunkts „Profile“ enthält Informationen zu den gefundenen Profilen, die mit den empfangenen Parametern und Kopfzeilen verknüpft sind.

  5. Wählen Sie ein Profil aus und fahren Sie mit Entscheidungsflüssen fort: Wenn die Antwort des Endpunkts „Profile“ Profile enthält, verwendet die Streaming-Anwendung ihre interne Logik (letztendlich durch Interaktion mit dem Endbenutzer), um eines der verfügbaren Profile auszuwählen, um mit nachfolgenden Entscheidungsflüssen fortzufahren.

  6. Fahren Sie mit dem Partnerauthentifizierungsfluss fort: Wenn die Endpunktantwort „Profile“ kein Profil enthält, fährt die Streaming-Anwendung mit dem Partnerauthentifizierungsfluss fort.

C. Authentifizierungsphase für Partner

  1. Konfiguration abrufen: Die Streaming-Anwendung erfasst alle erforderlichen Daten, um die Liste der MVPDs mit einer aktiven Integration abzurufen, indem eine Anfrage an den Konfigurationsendpunkt gesendet wird.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden finden Sie in der APIDokumentation zum Abrufen der Konfiguration für einen bestimmten Dienstleister:
    • Alle erforderlichen Parameter wie serviceProvider
    • Alle erforderlichen Kopfzeilen wie Authorization, AP-Device-Identifier und X-Device-Info
    • Alle optionalen Parameter und Kopfzeilen

  2. Rückgabekonfiguration: Die Antwort des Konfigurationsendpunkts enthält Informationen über die MVPDs, die eine aktive Integration mit dem Dienstleister aufweisen.

    note important
    IMPORTANT
    Weitere Informationen zu den in einer Konfigurationsantwort bereitgestellten Informationen finden Sie in der APIDokumentation zum Abrufen der Konfiguration für einen bestimmten Dienstleister.
    Der Konfigurationsendpunkt validiert die Anfragedaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:
    • Die erforderlichen Parameter und Kopfzeilen müssen gültig sein.
    Wenn die Validierung fehlschlägt, wird eine Fehlerantwort generiert, die zusätzliche Informationen entsprechend der Dokumentation Erweiterte Fehlercodes bereitstellt.
    note important
    IMPORTANT
    Die Streaming-Anwendung muss sicherstellen, dass sie die folgenden Details für jede MVPD verarbeitet, wenn sie fortfährt:
    • enablePlatformServices: Gibt an, ob die MVPD derzeit das Apple-Single Sign-on unterstützt.
    • displayInPlatformPicker: Gibt an, ob die MVPD in der Apple-Auswahl angezeigt werden kann.
    • boardingStatus: Gibt an, ob MVPD in Apple Single Sign-on integriert ist.

  3. Apple Partner-Framework-Status abrufen: Die Streaming-Anwendung ruft das von entwickelte Video Subscriber Account Framework auf, um Benutzerberechtigungen und Anbieterinformationen abzurufen.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden finden Sie in der DokumentationVideo Subscriber Account Framework):
    • Die Streaming-Anwendung muss die Abonnementinformationen des Benutzers auf Zugriffsberechtigung überprüfen und nur fortfahren, wenn der Benutzer dies erlaubt hat.
    • Die Streaming-Anwendung muss einen Delegaten für die VSAccountManager bereitstellen.
    • Die Streaming-Anwendung muss eine Anfrage für Abonnentenkontoinformationen senden.
    • Die Streaming-Anwendung muss warten und die Metadaten verarbeiten.
    Die Streaming-Anwendung muss sicherstellen, dass sie einen booleschen Wert angibt, der true für die isInterruptionAllowed-Eigenschaft im VSAccountMetadataRequest-Objekt entspricht, um anzugeben, dass der Benutzer in dieser Phase unterbrochen werden kann, um einen TV-Anbieter auszuwählen.

  4. Partner-Framework-Statusinformationen zurückgeben: Die Streaming-Anwendung validiert die Antwortdaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:

    • Der Benutzerberechtigungs-Zugriffsstatus wird gewährt.
    • Die Kennung der Benutzeranbieter-Zuordnung ist vorhanden und gültig.
    • Das Ablaufdatum des Benutzeranbieterprofils (falls verfügbar) ist gültig.

  5. Partnerauthentifizierungsanfrage abrufen: Die Streaming-Anwendung sammelt alle erforderlichen Daten, um eine Authentifizierungssitzung zu initiieren, indem sie den Sitzungspartner-Endpunkt aufruft.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden Themen finden in der APIDokumentation zum Abrufen von Partnerauthentifizierungsanfragen:
    • Alle erforderlichen Parameter wie serviceProvider und partner
    • Alle erforderlichen Kopfzeilen wie Authorization, AP-Device-Identifier, Content-Type, X-Device-Info und AP-Partner-Framework-Status
    • Alle optionalen Kopfzeilen und Parameter
    Die Streaming-Anwendung muss sicherstellen, dass sie einen gültigen Wert für den Partner-Framework-Status enthält, sodass die abgerufene Antwort eine Partner-Authentifizierungsanfrage (SAML-Anfrage) enthalten kann.
    Weitere Informationen zu AP-Partner-Framework-Status Kopfzeile finden Sie in der Dokumentation AP-Partner-Framework-Status.

  6. Nächste Aktion angeben: Die Antwort des Sitzungspartner-Endpunkts enthält die erforderlichen Daten, um die Streaming-Anwendung bezüglich der nächsten Aktion zu leiten.

    note important
    IMPORTANT
    Weitere Informationen zu den in einer Sitzungsantwort bereitgestellten Informationen finden Sie in der APIDokumentation zum Abrufen der Partnerauthentifizierungsanfrage .
    Der Sitzungspartner-Endpunkt validiert die Anfragedaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:
    • Die erforderlichen Parameter und Kopfzeilen müssen gültig sein.
    • Die Integration zwischen den bereitgestellten serviceProvider und mvpd muss aktiv sein.
    Wenn die einfache Validierung fehlschlägt, wird eine Fehlerantwort generiert, die zusätzliche Informationen entsprechend der Dokumentation Erweiterte Fehlercodes bereitstellt.
    Der Sitzungspartner-Endpunkt validiert die Anfragedaten, um sicherzustellen, dass die Bedingungen für das einmalige Anmelden des Partners erfüllt sind:
    • Die Partnerkonfiguration für einmaliges Anmelden im Adobe Pass-Server muss gültig und aktiviert sein.
    • Die Payload des Partner-Frameworks, die über die Kopfzeile AP-Partner-Framework-Status empfangen wurde, muss gültig sein.
    Wenn die Validierung des Partner-Single-Sign-ons fehlschlägt, wird die Antwort standardmäßig auf den einfachen Authentifizierungsfluss eingestellt.

  7. Fahren Sie mit Entscheidungsflüssen fort: Die Antwort „Sitzungspartner-Endpunkt“ enthält die folgenden Daten:

    • Das actionName-Attribut ist auf „authorize“ festgelegt.
    • Das actionType-Attribut ist auf „direct“ festgelegt.

    Wenn das Adobe Pass-Backend ein gültiges Profil identifiziert, muss sich die Streaming-Anwendung nicht erneut mit dem ausgewählten MVPD authentifizieren, da bereits ein Profil vorhanden ist, das für nachfolgende Entscheidungsflüsse verwendet werden kann.

  8. Mit einfachem Authentifizierungsfluss fortfahren: Die Antwort des Sitzungspartner-Endpunkts enthält die folgenden Daten:

    • Das actionName-Attribut wird entweder auf „Authentifizieren“ oder auf „Fortsetzen“ festgelegt.
    • Das actionType-Attribut wird entweder auf „interaktiv“ oder auf „direkt“ festgelegt.

    Wenn das Adobe Pass-Backend kein gültiges Profil identifiziert und die Partnerüberprüfung für einmaliges Anmelden fehlschlägt, kehrt der Adobe Pass-Server zum einfachen Authentifizierungsfluss zurück.

    Weitere Informationen zum grundlegenden Authentifizierungsablauf finden Sie in den folgenden Dokumenten:

  9. Fahren Sie mit dem Erstellen und Abrufen eines Profils mithilfe des Antwortflusses zur Partnerauthentifizierung fort: Die Antwort „Sitzungspartner-Endpunkt“ enthält die folgenden Daten:

    • Das actionName-Attribut ist auf „partner_profile“ festgelegt.
    • Das actionType-Attribut ist auf „direct“ festgelegt.
    • Das authenticationRequest - type-Attribut enthält das Sicherheitsprotokoll, das vom Partner-Framework für die Anmeldung bei MVPD verwendet wird (derzeit nur auf SAML festgelegt).
    • Das authenticationRequest - request-Attribut enthält die SAML-Anfrage, die an das Partner-Framework übergeben wird.
    • Das authenticationRequest - attributesNames-Attribut enthält die SAML-Attribute, die an das Partner-Framework übergeben werden.

    Wenn das Adobe Pass-Backend kein gültiges Profil identifiziert und die Partnervalidierung mit Single Sign-on erfolgreich ist, erhält die Streaming-Anwendung eine Antwort mit Aktionen und Daten, die an das Partner-Framework übergeben werden, um den Authentifizierungsfluss mit der MVPD zu starten.

  10. Abschließen der MVPD-Authentifizierung mit dem Partner-Framework Leitet die im vorherigen Schritt erhaltene Partnerauthentifizierungsanfrage (SAML-Anfrage) an das Framework für Videoabonnentenkonten weiter. Wenn der Authentifizierungsfluss erfolgreich ist, führt die Video Subscriber Account Framework-Interaktion mit der MVPD zu einer Partnerauthentifizierungsantwort (SAML-Antwort), die zusammen mit den Statusinformationen des Partner-Frameworks zurückgegeben wird.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden finden Sie in der DokumentationVideo Subscriber Account Framework):
    • Die Streaming-Anwendung muss die Abonnementinformationen des Benutzers auf Zugriffsberechtigung überprüfen und nur fortfahren, wenn der Benutzer dies erlaubt hat.
    • Die Streaming-Anwendung muss einen Delegaten für die VSAccountManager bereitstellen.
    • Die Streaming-Anwendung muss eine Anforderung für Informationen zum Abonnentenkonto senden und die im vorherigen Schritt erhaltene Partnerauthentifizierungsanfrage (SAML-Anfrage) enthalten.
    • Die Streaming-Anwendung muss warten und die Metadaten verarbeiten.
    Die Streaming-Anwendung muss sicherstellen, dass sie einen booleschen Wert true für die isInterruptionAllowed Eigenschaft im VSAccountMetadataRequest angibt, um anzugeben, dass die Benutzerin bzw. der Benutzer unterbrochen werden kann, um sich in dieser Phase beim ausgewählten TV-Anbieter zu authentifizieren.

  11. Antwort zur Partnerauthentifizierung zurückgeben: Die Streaming-Anwendung validiert die Antwortdaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:

    • Der Benutzerberechtigungs-Zugriffsstatus wird gewährt.
    • Die Kennung der Benutzeranbieter-Zuordnung ist vorhanden und gültig.
    • Das Ablaufdatum des Benutzeranbieterprofils (falls verfügbar) ist gültig.
    • Die Partnerauthentifizierungsantwort (SAML-Antwort) ist vorhanden und gültig.

  12. Profil mit Partnerauthentifizierungsantwort erstellen und abrufen: Die Streaming-Anwendung sammelt alle erforderlichen Daten, um ein Profil zu erstellen und abzurufen, indem sie den Partner-Endpunkt „Profile“ aufruft.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden finden Sie in der API-DokumentationErstellen und Abrufen von Profilen mit Partnerauthentifizierungsantwort:
    • Alle erforderlichen Parameter wie serviceProvider, partner und SAMLResponse
    • Alle erforderlichen Kopfzeilen wie Authorization, AP-Device-Identifier, Content-Type, X-Device-Info und AP-Partner-Framework-Status
    • Alle optionalen Kopfzeilen und Parameter
    Die Streaming-Anwendung muss sicherstellen, dass sie gültige Werte für den Partner-Framework-Status und die Partner-Authentifizierungsantwort (SAML-Antwort) enthält, sodass die abgerufene Antwort ein Profil vom Typ „appleSSO“ enthalten kann.
    Weitere Informationen zu AP-Partner-Framework-Status Kopfzeile finden Sie in der Dokumentation AP-Partner-Framework-Status.

  13. Rückgabeinformationen zum Partnerprofil: Die Antwort des Endpunkts „Profile“ enthält Informationen zum Partnerprofil, einschließlich des Attributs, das auf „appleSSO“ festgelegt type.

    note important
    IMPORTANT
    Weitere Informationen zu in einer Profilantwort enthaltenen Informationen finden Sie in der APIDokumentation Erstellen und Abrufen von Profilen mit Partnerauthentifizierungsantwort .
    Der Profilpartner-Endpunkt validiert die Anfragedaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:
    • Die erforderlichen Parameter und Kopfzeilen müssen gültig sein.
    • Die Integration zwischen den bereitgestellten serviceProvider und mvpd muss aktiv sein.
    Wenn die Validierung fehlschlägt, wird eine Fehlerantwort generiert, die zusätzliche Informationen entsprechend der Dokumentation Erweiterte Fehlercodes bereitstellt.
    Der Partner-Endpunkt „Profile“ validiert die Anfragedaten, um sicherzustellen, dass die Bedingungen für das einmalige Anmelden des Partners erfüllt sind:
    • Die Partnerkonfiguration für einmaliges Anmelden im Adobe Pass-Server muss gültig und aktiviert sein.
    • Die Payload des Partner-Frameworks, die über die Kopfzeile AP-Partner-Framework-Status empfangen wurde, muss gültig sein.
    Wenn die Validierung des Partner-Single-Sign-ons fehlschlägt, wird als Antwort standardmäßig der grundlegende Profilabruffluss verwendet.

  14. Fahren Sie mit Entscheidungsflüssen fort: Die Streaming-Anwendung kann mit nachfolgenden Entscheidungsflüssen fortfahren.

D. Entscheidungsphase

  1. Apple Partner-Framework-Status abrufen: Die Streaming-Anwendung ruft das von entwickelte Video Subscriber Account Framework auf, um Benutzerberechtigungen und Anbieterinformationen abzurufen.

    note important
    IMPORTANT
    Die Streaming-Anwendung kann diesen Schritt überspringen, wenn der ausgewählte Benutzerprofiltyp nicht „appleSSO“ lautet.
    note important
    IMPORTANT
    Weitere Informationen zu folgenden finden Sie in der DokumentationVideo Subscriber Account Framework):
    • Die Streaming-Anwendung muss die Abonnementinformationen des Benutzers auf Zugriffsberechtigung überprüfen und nur fortfahren, wenn der Benutzer dies erlaubt hat.
    • Die Streaming-Anwendung muss einen Delegaten für die VSAccountManager bereitstellen.
    • Die Streaming-Anwendung muss eine Anfrage für Abonnentenkontoinformationen senden.
    • Die Streaming-Anwendung muss warten und die Metadaten verarbeiten.
    Die Streaming-Anwendung muss sicherstellen, dass sie einen booleschen Wert angibt, der false für die isInterruptionAllowed-Eigenschaft im VSAccountMetadataRequest-Objekt entspricht, um anzugeben, dass der Benutzer in dieser Phase nicht unterbrochen werden kann.
    note tip
    TIP
    Die Streaming-Anwendung kann stattdessen einen zwischengespeicherten Wert für die Partner-Framework-Statusinformationen verwenden, den wir aktualisieren sollten, wenn die Anwendung vom Hintergrund- in den Vordergrundstatus wechselt. In diesem Fall muss die Streaming-Anwendung sicherstellen, dass sie zwischenspeichert und nur gültige Werte für den Partner-Framework-Status verwendet, wie im Schritt „Informationen zum Partner-Framework-Status zurückgeben“ beschrieben.

  2. Partner-Framework-Statusinformationen zurückgeben: Die Streaming-Anwendung validiert die Antwortdaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:

    • Der Benutzerberechtigungs-Zugriffsstatus wird gewährt.
    • Die Kennung der Benutzeranbieter-Zuordnung ist vorhanden und gültig.
    • Das Ablaufdatum des Benutzeranbieterprofils ist gültig.
    note important
    IMPORTANT
    Die Streaming-Anwendung kann diesen Schritt überspringen, wenn der ausgewählte Benutzerprofiltyp nicht „appleSSO“ lautet.

  3. Vorabautorisierungsentscheidungen abrufen: Die Streaming-Anwendung sammelt alle erforderlichen Daten, um Vorabautorisierungsentscheidungen für eine Liste von Ressourcen zu erhalten, indem sie den Endpunkt Decisions Preauthorize aufruft.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden Themen finden in der APIDokumentation zum Abrufen von Vorabautorisierungsentscheidungen mithilfe bestimmter MVPD:
    • Alle erforderlichen Parameter wie serviceProvider, mvpd und resources
    • Alle erforderlichen Kopfzeilen wie Authorization und AP-Device-Identifier
    • Alle optionalen Parameter und Kopfzeilen
    Die Streaming-Anwendung muss sicherstellen, dass sie einen gültigen Wert für den Partner-Framework-Status enthält, bevor sie eine weitere Anfrage stellt, wenn das ausgewählte Profil ein Profil vom Typ „appleSSO“ ist. Dieser Schritt kann jedoch übersprungen werden, wenn der ausgewählte Benutzerprofiltyp nicht „appleSSO“ ist.
    Weitere Informationen zu AP-Partner-Framework-Status Kopfzeile finden Sie in der Dokumentation AP-Partner-Framework-Status.

  4. Entscheidungen zur Vorautorisierung zurückgeben: Die Antwort des Endpunkts „Decisions Preauthorize“ enthält für jede Ressource eine Permit oder Deny Entscheidung:

    • Eine Permit Entscheidung bedeutet, dass die Ressource abspielbar ist. Die Antwort enthält kein Medien-Token, da der Vorautorisierungsfluss nicht zum Wiedergeben von Ressourcen verwendet werden darf.
    • Eine Deny Entscheidung bedeutet, dass die Ressource nicht abspielbar ist. Die Antwort enthält eine Fehler-Payload, die der Dokumentation Erweiterte Fehlercodes entspricht.
    note important
    IMPORTANT
    Weitere Informationen zu den in einer Entscheidungsantwort bereitgestellten Informationen finden Sie in der APIDokumentation zum Abrufen von Entscheidungen vor der Autorisierung mit bestimmten mvpd.
    Der Endpunkt Decisions Preauthorize validiert die Anfragedaten, um sicherzustellen, dass grundlegende Bedingungen erfüllt werden:
    • Die erforderlichen Parameter und Kopfzeilen müssen gültig sein.
    • Die Integration zwischen den bereitgestellten serviceProvider und mvpd muss aktiv sein.
    Wenn die Validierung fehlschlägt, wird eine Fehlerantwort generiert, die zusätzliche Informationen entsprechend der Dokumentation Erweiterte Fehlercodes bereitstellt.

  5. Apple Partner-Framework-Status abrufen: Die Streaming-Anwendung ruft das von entwickelte Video Subscriber Account Framework auf, um Benutzerberechtigungen und Anbieterinformationen abzurufen.

    note important
    IMPORTANT
    Die Streaming-Anwendung kann diesen Schritt überspringen, wenn der ausgewählte Benutzerprofiltyp nicht „appleSSO“ lautet.
    note important
    IMPORTANT
    Weitere Informationen zu folgenden finden Sie in der DokumentationVideo Subscriber Account Framework):
    • Die Streaming-Anwendung muss die Abonnementinformationen des Benutzers auf Zugriffsberechtigung überprüfen und nur fortfahren, wenn der Benutzer dies erlaubt hat.
    • Die Streaming-Anwendung muss einen Delegaten für die VSAccountManager bereitstellen.
    • Die Streaming-Anwendung muss eine Anfrage für Abonnentenkontoinformationen senden.
    • Die Streaming-Anwendung muss warten und die Metadaten verarbeiten.
    Die Streaming-Anwendung muss sicherstellen, dass sie einen booleschen Wert angibt, der false für die isInterruptionAllowed-Eigenschaft im VSAccountMetadataRequest-Objekt entspricht, um anzugeben, dass der Benutzer in dieser Phase nicht unterbrochen werden kann.
    note tip
    TIP
    Die Streaming-Anwendung kann stattdessen einen zwischengespeicherten Wert für die Partner-Framework-Statusinformationen verwenden, den wir aktualisieren sollten, wenn die Anwendung vom Hintergrund- in den Vordergrundstatus wechselt. In diesem Fall muss die Streaming-Anwendung sicherstellen, dass sie zwischenspeichert und nur gültige Werte für den Partner-Framework-Status verwendet, wie im Schritt „Informationen zum Partner-Framework-Status zurückgeben“ beschrieben.

  6. Partner-Framework-Statusinformationen zurückgeben: Die Streaming-Anwendung validiert die Antwortdaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:

    • Der Benutzerberechtigungs-Zugriffsstatus wird gewährt.
    • Die Kennung der Benutzeranbieter-Zuordnung ist vorhanden und gültig.
    • Das Ablaufdatum des Benutzeranbieterprofils ist gültig.
    note important
    IMPORTANT
    Die Streaming-Anwendung kann diesen Schritt überspringen, wenn der ausgewählte Benutzerprofiltyp nicht „appleSSO“ lautet.

  7. Autorisierungsentscheidung abrufen: Die Streaming-Anwendung erfasst alle erforderlichen Daten, um eine Autorisierungsentscheidung für eine bestimmte Ressource zu erhalten, indem sie den Decisions Authorize-Endpunkt aufruft.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden Themen finden in der APIDokumentation zum Abrufen von Autorisierungsentscheidungen mithilfe bestimmter MVPD:
    • Alle erforderlichen Parameter wie serviceProvider, mvpd und resources
    • Alle erforderlichen Kopfzeilen wie Authorization und AP-Device-Identifier
    • Alle optionalen Parameter und Kopfzeilen
    Die Streaming-Anwendung muss sicherstellen, dass sie einen gültigen Wert für den Partner-Framework-Status enthält, bevor sie eine weitere Anfrage stellt, wenn das ausgewählte Profil ein Profil vom Typ „appleSSO“ ist. Dieser Schritt kann jedoch übersprungen werden, wenn der ausgewählte Benutzerprofiltyp nicht „appleSSO“ ist.
    Weitere Informationen zu AP-Partner-Framework-Status Kopfzeile finden Sie in der Dokumentation AP-Partner-Framework-Status.

  8. Rückkehrautorisierungsentscheidung: Die Endpunktantwort „Decisions Authorize“ enthält eine Permit oder Deny Entscheidung für die spezifische Ressource:

    • Eine Permit Entscheidung bedeutet, dass die Ressource abspielbar ist. Die Antwort enthält ein Medien-Token.
    • Eine Deny Entscheidung bedeutet, dass die Ressource nicht abspielbar ist. Die Antwort enthält eine Fehler-Payload, die der Dokumentation Erweiterte Fehlercodes entspricht.
    note important
    IMPORTANT
    Weitere Informationen zu den in einer Entscheidungsantwort bereitgestellten Informationen finden Sie in der APIDokumentation zum Abrufen von Autorisierungsentscheidungen mithilfe einer bestimmten mvpd.
    Der Decisions-Autorisierungs-Endpunkt validiert die Anfragedaten, um sicherzustellen, dass grundlegende Bedingungen erfüllt werden:
    • Die erforderlichen Parameter und Kopfzeilen müssen gültig sein.
    • Die Integration zwischen den bereitgestellten serviceProvider und mvpd muss aktiv sein.
    Wenn die Validierung fehlschlägt, wird eine Fehlerantwort generiert, die zusätzliche Informationen entsprechend der Dokumentation Erweiterte Fehlercodes bereitstellt.
D. Abmeldephase

  1. Adobe Pass-Abmeldung initiieren: Die Streaming-Anwendung sammelt alle erforderlichen Daten, um den Abmeldefluss zu initiieren, indem sie den Adobe Pass-Abmelde-Endpunkt aufruft.

    note important
    IMPORTANT
    Weitere Informationen zu folgenden Themen finden Sie in API-DokumentationInitiieren des Abmeldens für bestimmte MVPD:
    • Alle erforderlichen Parameter wie serviceProvider, mvpd und redirectUrl
    • Alle erforderlichen Kopfzeilen wie Authorization, AP-Device-Identifier
    • Alle optionalen Parameter und Kopfzeilen

  2. Nächste Aktion angeben: Die Antwort des Abmeldeendpunkts von Adobe Pass enthält die erforderlichen Daten, um die Streaming-Anwendung bezüglich der nächsten Aktion zu führen:

    • Das url fehlt, da der Benutzer mit der Partner-(System-)Ebene interagieren muss, um den Abmeldefluss abzuschließen.
    • Das actionName-Attribut ist auf „partner_logout“ festgelegt.
    • Das actionType-Attribut ist auf „partner_interactive“ festgelegt.
    note important
    IMPORTANT
    Die Streaming-Anwendung muss den Benutzer auffordern, den Abmeldevorgang auf Partnerebene abzuschließen, wie in den Attributen actionName und actionType angegeben, wenn der entfernte Benutzerprofiltyp „appleSSO“ ist.
    note important
    IMPORTANT
    Weitere Informationen zu den in einer Abmeldeantwort enthaltenen Informationen finden Sie in der APIDokumentation zum Initiieren des Abmeldens für bestimmte mvpd.
    Der Adobe Pass-Abmeldeendpunkt validiert die Anfragedaten, um sicherzustellen, dass die grundlegenden Bedingungen erfüllt sind:
    • Die erforderlichen Parameter und Kopfzeilen müssen gültig sein.
    • Die Integration zwischen den bereitgestellten serviceProvider und mvpd muss aktiv sein.
    Wenn die Validierung fehlschlägt, wird eine Fehlerantwort generiert, die zusätzliche Informationen entsprechend der Dokumentation Erweiterte Fehlercodes bereitstellt.
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b