Apple SSO Cookbook (iOS/tvOS SDK) apple-sso-cookbook-iostvos-sdk

IMPORTANT
De inhoud op deze pagina wordt alleen ter informatie verstrekt. Voor het gebruik van deze API is een huidige licentie van Adobe vereist. Ongeautoriseerd gebruik is niet toegestaan.

De Adobe Pass Authentication AccessEnabler iOS/tvOS SDK biedt ondersteuning voor Single Sign-On (SSO) voor eindgebruikers van clienttoepassingen die op iOS, iPadOS of tvOS worden uitgevoerd.

Dit document doet dienst als uitbreiding aan de bestaande documentatie van AccessEnabler iOS/tvOS SDK, die hierkan worden gevonden.

Cookbook apple-sso-cookbook-iostvos-sdk-cookbook

Om te kunnen profiteren van de Apple SSO-gebruikerservaring, moet de toepassing de AccessEnabler iOS/tvOS SDK integreren en de onderstaande reeks stappen volgen.

Vereisten apple-sso-cookbook-iostvos-sdk-prerequisites

Machtiging apple-sso-cookbook-iostvos-sdk-permission

TIP
ProUiteinde: de het stromen toepassing moet toegang tot de het abonnementinformatie van de gebruiker verzoeken die op apparatenniveau wordt bewaard, waarvoor de gebruiker de toepassingstoestemming moet geven te werk te gaan, gelijkend op het verlenen van toegang tot de camera of microfoon van het apparaat. Deze toestemming moet per toepassing worden gevraagd gebruikend het Kader van de Rekening van de Abonnee van Apple Videoen het apparaat zal de selectie van de gebruiker bewaren.
TIP
ProUiteinde: wij adviseren gebruikers te stimuleren die weigeren om toestemming te geven om tot abonnementinformatie toegang te hebben door de voordelen van de enige sign-on gebruikerservaring van Apple uit te leggen, maar zich ervan bewust te zijn dat de gebruiker hun besluit kan veranderen door naar de toepassingsmontages (de toestemmingstoegang van TV Provider) of naar Settings -> TV Provider op iOS en iPadOS of Settings -> Accounts -> TV Provider op tvOS te gaan.
TIP
ProUiteinde: de het stromen toepassing kan om de toestemming van de gebruiker verzoeken wanneer de toepassing de voorgrondstaat ingaat, omdat de toepassing toestemming kan controleren om totde het abonnementsinformatie van de gebruiker op om het even welk punt toegang te hebben alvorens gebruikersauthentificatie te vereisen.
TIP
ProTip: als de gebruiker geen toegang tot zijn abonnementsinformatie verleent of in het geval dat de communicatie met het Video Kader van de Rekening van de Abonnee ontbreekt, dan zal AccessEnabler iOS/tvOS SDK terug naar de regelmatige authentificatiestroom vallen.
    ...
    let videoSubscriberAccountManager: VSAccountManager = VSAccountManager();

    videoSubscriberAccountManager.checkAccessStatus(options: [VSCheckAccessOption.prompt: true]) { (accessStatus, error) -> Void in
                switch (accessStatus) {
                // The user allows the application to access subscription information.
                case VSAccountAccessStatus.granted:
                   // Do nothing.

                // The user has not yet made a choice or does not allow the application to access subscription information.
                default:
                   // Incentivize users who refuse to give permission to access subscription information by explaining the benefits of the Single Sign-On (SSO) user experience. Please bear in mind that the user can change its decision by going to the application settings (TV Provider permission access) or to the section from Settings -> TV Provider on iOS/iPadOS or Settings -> Accounts -> TV Provider on tvOS.
                   ...
                }
    }
    ...

Callbacks apple-sso-cookbook-iostvos-sdk-callbacks

TIP
ProUiteinde: voer de volgende lijst van callbacksuit die voor het werkschema van Apple SSO specifiek zijn.

Fout bij rapporteren apple-sso-cookbook-iostvos-sdk-error-reporting

TIP
ProUiteinde: voer de volgende lijst van geavanceerde foutencodesuit die voor het werkschema van Apple SSO specifiek zijn.
  • N003 - de gebruiker selecteerde de "Andere optie van de Leverancier van TV"van de Plukker van Apple MVPD.
  • N004 - de gebruiker selecteerde een Leverancier van TV van de plukker van Apple MVPD, die niet (integratie of Enige Sign-On gehandicapten) door de huidige aanvrager wordt gesteund.
  • N005 - de gebruiker besloot om de regelmatige plukker MVPD of de plukker van Apple MVPD te annuleren.
  • VSA403 - de toestemming van TV van de gebruiker wordt van de Leverancier ontkend voor de toepassing.
  • VSA404 - de toestemming van de leverancier van TV van de gebruiker is onbepaald voor de toepassing.
  • VSA503 - het Video Ontbroken de meta-gegevensverzoek van de Rekening van de Abonnee, meer context wordt verstrekt in het bericht gebied.
  • AAPL / APPL_ERROR - het Video Ontbroken de meta-gegevensverzoek van de Rekening van de Abonnee, meer context wordt verstrekt op het details gebied.

Verificatie apple-sso-cookbook-iostvos-sdk-authentication

TIP
Tip: volg de stappen hieronder voor iOS/iPadOS/tvOS implementatie/s.
  1. De toepassing zou 🔗 moeten initialiseren AccessEnabler iOS/tvOS SDK.

  2. De toepassing zou het huidige vraagherkenningstekenmoeten plaatsen.

    Belangrijk: Deze tweede stap kon een geavanceerde foutencodeteweegbrengen die voor het werkschema van Apple SSO specifiek is, in het geval één van het volgende waar is:

    • VSA403 - de toestemming van TV van de gebruiker wordt van de Leverancier ontkend voor de toepassing.
    • VSA404 - de toestemming van de leverancier van TV van de gebruiker is onbepaald voor de toepassing.
    • APPL - de communicatie tussen AccessEnabler iOS/tvOS SDK en het Video Kader van de Rekening van de Abonnee ontmoette een fout.

    Deze tweede stap zou proberen om het profiel van Apple SSO voor een teken van de Adobe authentificatie stil te ruilen, voor het geval alle hierboven vals zijn en elk van het volgende is waar:

    • De machtiging van de tv-provider van de gebruiker wordt verleend voor de toepassing.
    • De gebruiker is aangemeld bij zijn tv-provider-account op apparaatsysteemniveau.
    • De AccessEnabler iOS/tvOS SDK heeft de tv-provider-id van de gebruiker ontvangen via het Video Subscriber Account Framework.
    • De integratie van de tv-provider van de gebruiker met de toepassing wordt mogelijk gemaakt via het Adobe Primetime TVE-dashboard.
    • De eenmalige aanmelding bij de toepassing door de tv-provider van de gebruiker wordt ingeschakeld via het Adobe Primetime TVE-dashboard.
    • De tv-provider van de gebruiker wordt niet gedegradeerd via het Adobe Primetime TVE-dashboard.
    • De AccessEnabler iOS/tvOS SDK heeft de SAML-reactie van de tv-provider van de gebruiker ontvangen van het Video Subscriber Account Framework.

    ProUiteinde: Deze tweede stap zal geen andere callbacks, behalve setRequestorCompletecallback teweegbrengen, aangezien de authentificatie niet uitdrukkelijk door de toepassing in werking werd gesteld.

  3. De toepassing zou de authentificatiestatusmoeten controleren.

    Belangrijk: Deze derde stap kon een geavanceerde foutencodeteweegbrengen die voor het werkschema van Apple SSO specifiek is, in het geval één van het volgende waar is:

    • *VSA403 - de gebruiker wordt binnen ondertekend aan zijn rekening van TV Provider bij
      het systeemniveau van het apparaat, maar de machtiging van de tv-provider van de gebruiker is
      geweigerd voor de toepassing.
    • *VSA404 - de gebruiker wordt binnen ondertekend aan zijn rekening van TV Provider bij
      het systeemniveau van het apparaat, maar de machtiging van de tv-provider van de gebruiker
      is onbepaald voor de toepassing.
    • *APPL _ERROR - de gebruiker wordt binnen ondertekend aan zijn Dienstverlener van TV
      account op apparaatsysteemniveau, maar de communicatie tussen
      de AccessEnabler iOS/tvOS SDK en de Video Subscriber Account
      Er is een fout opgetreden.

    Belangrijk: Deze derde stap zal setAuthenticationStatus callback met status gelijk aan 0 teweegbrengen, voor het geval één van het volgende waar is:

    • De gebruiker wordt niet aangemeld bij zijn tv-provider-account op het systeemniveau van het apparaat of via een regelmatige verificatiestroom.
    • De gebruiker is aangemeld bij zijn tv-provider-account op apparaatsysteemniveau of via een regelmatige verificatiestroom, maar het verificatietoken van de tv-provider van de gebruiker is geslaagd.
    • De gebruiker wordt aangemeld bij zijn tv-provider-account op apparaatsysteemniveau of via een regelmatige verificatiestroom, maar de integratie van de tv-provider van de gebruiker met de toepassing wordt uitgeschakeld via het Adobe Primetime TVE-dashboard.
    • De gebruiker is aangemeld bij zijn tv-provider-account op apparaatsysteemniveau, maar de eenmalige aanmelding bij de toepassing door de tv-provider van de gebruiker is uitgeschakeld via het Adobe Primetime TVE-dashboard.
    • De gebruiker is aangemeld bij zijn tv-provider-account op apparaatsysteemniveau, maar de toestemming van de tv-provider van de gebruiker wordt geweigerd voor de toepassing.
    • De gebruiker is aangemeld bij zijn tv-provider-account op apparaatsysteemniveau, maar de toestemming van de tv-provider van de gebruiker is onbepaald voor de toepassing.
    • De gebruiker is aangemeld bij zijn tv-provider-account op apparaatsysteemniveau, maar er is een fout opgetreden tijdens de communicatie tussen de AccessEnabler iOS/tvOS SDK en het Video Subscriber Account Framework.

    Belangrijk: Deze derde stap zal setAuthenticationStatus callback met status gelijk aan 1 teweegbrengen, voor het geval alle hierboven vals zijn.

  4. De toepassing zou de authentificatie 🔗 moeten initialiseren in het geval dat de vorige controle van de authentificatiestatus setAuthenticationStatus callback met status gelijk aan 0 teweegbracht.

    ProUiteinde: voer één van volgende AccessEnabler iOS/tvOS SDK API getAuthenticationof getAuthentication uit:filter.

    Belangrijk: Deze vierde stap kon een geavanceerde foutencodeteweegbrengen die voor het werkschema van Apple SSO specifiek is, in het geval één van het volgende waar is:

    • VSA403 - de toestemming van TV van de gebruiker wordt van de Leverancier ontkend voor de toepassing.
    • VSA404 - de toestemming van de leverancier van TV van de gebruiker is onbepaald voor de toepassing.
    • VSA503 - de communicatie tussen AccessEnabler iOS/tvOS SDK en het Video Kader van de Rekening van de Abonnee ontmoette een fout.
    • N003 - de gebruiker selecteerde de "Andere optie van de Leverancier van TV"van de Plukker van Apple MVPD.
    • N004 - de gebruiker selecteerde een Leverancier van TV van de plukker van Apple MVPD, die niet (integratie of Enige Sign-On gehandicapten) door de huidige aanvrager wordt gesteund.
    • N005 - de gebruiker besloot om de regelmatige plukker MVPD of de plukker van Apple MVPD te annuleren.

    Belangrijk: Deze vierde stap zou terug naar de regelmatige authentificatiestroom vallen, door displayProviderDialogcallback en één van de bovengenoemde geavanceerde foutencodesin werking te stellen, voor het geval één van het bovengenoemde is waar.

    Belangrijk: Deze vierde stap zou terug naar de regelmatige authentificatiestroom vallen, door navigateToUrlof navigateToUrl:useSVCcallback en niets van de bovengenoemde geavanceerde foutencodeste teweegbrengen, in het geval de gebruiker een leverancier van TV selecteerde, die geen Apple SSO steunt, maar aanwezig is in de Apple MVPD-kiezer.

    ProUiteinde: AccessEnabler iOS/tvOS SDK roept stil setSelectedProviderAPI, voor het geval de gebruiker een leverancier van TV selecteerde, die geen Apple SSO steunt, maar in de plukker van Apple MVPD aanwezig is.

    Belangrijk: Deze vierde stap zou proberen om het profiel van Apple SSO voor een teken van de Adobe authentificatie stil te ruilen, voor het geval alle hierboven vals zijn en elk van het volgende is waar:

    • De machtiging van de tv-provider van de gebruiker wordt verleend voor de toepassing.
    • De gebruiker is aangemeld / momenteel aangemeld bij de TV Provider-account op apparaatsysteemniveau.
    • De AccessEnabler iOS/tvOS SDK heeft de tv-provider-id van de gebruiker ontvangen via het Video Subscriber Account Framework.
    • De integratie van de tv-provider van de gebruiker met de toepassing wordt mogelijk gemaakt via het Adobe Primetime TVE-dashboard.
    • De eenmalige aanmelding bij de toepassing door de tv-provider van de gebruiker wordt ingeschakeld via het Adobe Primetime TVE-dashboard.
    • De tv-provider van de gebruiker wordt niet gedegradeerd via het Adobe Primetime TVE-dashboard.
    • De AccessEnabler iOS/tvOS SDK heeft de SAML-reactie van de tv-provider van de gebruiker ontvangen van het Video Subscriber Account Framework.

    ProUiteinde: Deze vierde stap zal setAuthenticationStatus callback, ongeacht status resultaat teweegbrengen, aangezien de authentificatie uitdrukkelijk door de toepassing in werking werd gesteld.

Metagegevens apple-sso-cookbook-iostvos-sdk-metadata

De toepassing heeft de optie om te bepalen als de authentificatie als resultaat van aanmelding door de Partner SSO of niet is gebeurd, gebruikend "tokenSource" gebruikersmeta-gegevensAPI van AccessEnabler iOS/tvOS SDK.

    ...
    accessEnabler.getMetadata([METADATA_OPCODE_KEY:Int(METADATA_USER_META), METADATA_USER_META_KEY: "tokenSource"])
    ...

Afmelden apple-sso-cookbook-iostvos-sdk-logout

Het Video Kader van de Rekening van de Abonnee van de Abonneeverstrekt geen API aan programmatically logout mensen die binnen aan hun de leveranciersrekening van TV op het niveau van het apparatensysteem hebben ondertekend. Daarom moet de eindgebruiker zich expliciet afmelden bij Settings -> TV Provider op iOS/iPadOS of Settings -> Accounts -> TV Provider op tvOS, anders wordt de aanmelding niet volledig van kracht. De andere optie die de gebruiker zou hebben, is het intrekken van de machtiging om de abonnementsgegevens van de gebruiker te openen in het gedeelte met specifieke toepassingsinstellingen (toegang tot tv-provider-machtiging).

TIP
Uiteinde: voer dit door het middel van AccessEnabler iOS/tvOS SDK logoutAPI uit.
TIP
ProUiteinde: volg de stappen hieronder voor de implementatie/s tvOS.
  • De toepassing zou de logout 🔗 van AccessEnabler iOS/tvOS SDK moeten in werking stellen . Dit zou sessieopruiming aan de MVPD-zijde niet vergemakkelijken.
  • De toepassing zou de gebruiker moeten instrueren/ertoe aanzetten om zich uitdrukkelijk uit Settings -> Accounts -> TV Provider op tvOS slechts in te tekenen voor het geval VSA203 statuscodewordt teweeggebracht.
TIP
ProTip: volg de stappen hieronder voor de implementatie/s iOS/iPadOS.
  • De toepassing zou de logout 🔗 van AccessEnabler iOS/tvOS SDK moeten in werking stellen . Dit zou zittingsschoonmaak aan de kant van MVPD vergemakkelijken.
  • De toepassing zou de gebruiker moeten instrueren/ertoe aanzetten om zich uitdrukkelijk uit Settings -> TV Provider op iOS/iPadOS slechts in het geval VSA203 statuscode wordt teweeggebrachtaf te melden.
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b