iOS/tvOS SDK Cookbook iostvos-sdk-cookbook

Skapa callback-funktioner:

• setRequestorComplete()

• Utlöses av setRequestor() och returnerar om åtgärden lyckades eller misslyckades.

• Slutfört visar att du kan fortsätta med berättigandeanrop.

• displayProviderDialog(mvpds)

  • Utlöses endast av getAuthentication() om användaren inte har valt en leverantör (MVPD) och ännu inte är autentiserad.
  • Parametern mvpds är en matris med providers som är tillgängliga för användaren.

• setAuthenticationStatus(status, errorcode)

  • Utlöses av checkAuthentication() varje gång.
  • Utlöses endast av getAuthentication() om användaren redan är autentiserad och har valt en leverantör.
  • Status som returneras är lyckad eller misslyckad. Felkoden beskriver typen av fel.

• navigateToUrl(url)

  • Utlöses av getAuthentication() efter att användaren har valt ett MVPD. Parametern url anger platsen för MVPD:s inloggningssida.

• sendTrackingData(event, data)

  • Utlöses av checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization(), setSelectedProvider().
  • Parametern event anger vilken berättigandehändelse som inträffade. Parametern data är en lista med värden som relaterar till händelsen.

• setToken(token, resource)

  • Utlöses av checkAuthorization() och getAuthorization() efter en auktorisering för att visa en resurs.
  • Parametern token är den kortlivade medietoken. Parametern resource är det innehåll som användaren har behörighet att visa.

• tokenRequestFailed(resource, code, description)

  • Utlöses av checkAuthorization() och getAuthorization() efter en misslyckad auktorisering.
  • Parametern resource är det innehåll som användaren försökte visa. Parametern code är felkoden som anger vilken typ av fel som uppstod. Parametern description beskriver felet som är associerat med felkoden.

• selectedProvider(mvpd)

  • Utlöses av getSelectedProvider().
  • Parametern mvpd ger information om providern som valts av användaren.

• setMetadataStatus(metadata, key, arguments)

  • Utlöses av getMetadata().
  • Parametern metadata innehåller de specifika data som du har begärt. Parametern key är nyckeln som används i begäran getMetadata() och parametern arguments är samma ordlista som skickades till getMetadata().

• preauthorizedResources(authorizedResources)

  • Utlöses av checkPreauthorizedResources().

  • Parametern authorizedResources visar de resurser som användaren
    har behörighet att se.

• presentTvProviderDialog(viewController)

  • Utlöses av getAuthentication() när den aktuella begäraren har stöd för minst en MVPD som har stöd för enkel inloggning.
  • Parametern viewController är Apple SSO-dialogrutan och måste presenteras på huvudvykontrollanten.

• dismissTvProviderDialog(viewController)

  • Utlöses av en användaråtgärd (genom att välja Avbryt eller Andra TV-leverantörer i Apple SSO-dialogruta).
  • Parametern viewController är Apple SSO-dialogrutan och måste stängas av från huvudvykontrollanten.

Starta programmet på den översta nivån.

Initiera Adobe Pass-autentisering

a. Anropa init för att skapa en enda instans av Adobe Pass Authentication AccessEnabler.

• Beroende: Adobe Pass Authentication Native iOS/tvOS Library (AccessEnabler)

b. Anropa setRequestor() för att etablera programmerarens identitet; skicka en matris med slutpunkter för Adobe Pass-autentisering i programmerarens requestorID och (eventuellt). För tvOS måste du även ange den offentliga nyckeln och hemligheten. Mer information finns i dokumentationen utan klienter.

• Beroende: Giltigt begärande-ID för Adobe Pass-autentisering (arbeta med ditt Adobe Pass-autentiseringskonto)
  Ansvarig för att ordna detta).

• Utlösare:

  setRequestorComplete()-återanrop.

Du har två implementeringsalternativ: När begärarens identifieringsinformation har skickats till backend-servern kan gränssnittets programlager välja en av följande två metoder:

1. Vänta på att återanropet setRequestorComplete() aktiveras (ingår i AccessEnabler-delegaten). Det här alternativet ger den största säkerheten för att setRequestor() har slutförts, så det rekommenderas för de flesta implementeringar.

2. Fortsätt utan att vänta på att återanropet setRequestorComplete() ska utlösas och börja utfärda tillståndsbegäranden. Dessa anrop (checkAuthentication, checkAuthorization, getAuthentication, getAuthorization, checkPreauthorizedResource, getMetadata, logout) köas av AccessEnabler-biblioteket, som kommer att göra de faktiska nätverksanropen efter setRequestor(). Det här alternativet kan ibland avbrytas om nätverksanslutningen till exempel är instabil.

Anropa checkAuthentication() för att kontrollera om det finns en befintlig autentisering utan att initiera det fullständiga autentiseringsflödet. Om samtalet lyckas kan du gå direkt till auktoriseringsflödet. Om inte, fortsätter du till autentiseringsflödet.

• Beroende: Ett lyckat anrop till setRequestor() (det här beroendet gäller även för alla efterföljande anrop).

• Utlösare: setAuthenticationStatus() återanrop.

Anropa getAuthentication() för att initiera autentiseringsflödet eller för att få en bekräftelse på att användaren redan är
autentiserad.

Utlösare:

• Callback-funktionen setAuthenticationStatus(), om användaren redan är autentiserad. I det här fallet går du direkt till auktoriseringsflödet.

• Callback-funktionen displayProviderDialog(), om användaren inte har autentiserats ännu.

Presentera användaren med listan över leverantörer som skickats till
displayProviderDialog().

När användaren har valt en provider hämtar du URL:en för användarens MVPD från navigateToUrl:- eller navigateToUrl:useSVC:-återanropet, öppnar en UIWebView/WKWebView - eller SFSafariViewController-kontrollant och dirigerar kontrollenheten till URL:en.

Genom UIWebView/WKWebView eller SFSafariViewController som instansierats i föregående steg, loggar användaren in på MVPD:s inloggningssida och anger inloggningsuppgifter. Flera omdirigeringsåtgärder utförs inom kontrollenheten.

När användaren har loggat in identifierar programlagret inläsningen av en specifik anpassad URL. Observera att den här anpassade URL:en är ogiltig och inte avsedd för att styrenheten ska läsa in den. Det får bara tolkas av programmet som en signal om att autentiseringsflödet har slutförts och att det är säkert att stänga UIWebView/WKWebView- eller SFSafariViewController-kontrollen. Om en SFSafariViewController-kontrollant måste användas definieras den anpassade URL:en av application's custom scheme (t.ex. adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com), annars definieras den här anpassade URL:en av konstanten ADOBEPASS_REDIRECT_URL (d.v.s. adobepass://ios.app).

Stäng styrenheten UIWebView/WKWebView eller SFSafariViewController och anropa AccessEnablers handleExternalURL:url-API-metod, som instruerar AccessEnabler att hämta autentiseringstoken från backend-servern.

(Valfritt) Ring checkPreauthorizedResources(resources) för att kontrollera vilka resurser användaren har behörighet att visa. Parametern resources är en matris med skyddade resurser som är associerad med användarens autentiseringstoken. En användning för auktoriseringsinformation som hämtas från användarens MVPD är att dekorera användargränssnittet (t.ex. låsta/olåsta symboler bredvid skyddat innehåll).

• Utlösare: preauthorizedResources() återanrop
• Körningspunkt: Efter det slutförda autentiseringsflödet

Om autentiseringen lyckades fortsätter du till auktoriseringsflödet.

Ring getAuthentication() för att initiera autentiseringsflödet eller för att få en bekräftelse på att användaren redan är autentiserad.
Utlösare:

• Callback-funktionen presentTvProviderDialog(), om användaren inte är autentiserad och den aktuella begäraren har minst ett MVPD-värde som stöder enkel inloggning. Om inga MVPD-program stöder enkel inloggning används det klassiska autentiseringsflödet.

När användaren har valt en provider får AccessEnabler-biblioteket en autentiseringstoken med information från Apple VSA-ramverk.

Callback-funktionen setAuthenticationsStatus() aktiveras. Nu bör användaren autentiseras med Apple SSO.

[Valfritt] samtal checkPreauthorizedResources(resources) för att kontrollera vilka resurser användaren har behörighet att visa. Parametern resources är en matris med skyddade resurser som är associerad med användarens autentiseringstoken. En användning för auktoriseringsinformation som hämtas från användarens MVPD är att dekorera användargränssnittet (t.ex. låsta/olåsta symboler bredvid skyddat innehåll).

• Utlösare: preauthorizedResources() återanrop
• Körningspunkt: Efter det slutförda autentiseringsflödet

Om autentiseringen lyckades fortsätter du till auktoriseringsflödet.

Ring getAuthentication() för att initiera
autentiseringsflöde, eller för att få bekräftelse på att användaren redan
autentiserad.
Utlösare:

• presentTvProviderDialog()-återanropet, om användaren inte är autentiserad och den aktuella begäraren har minst ett MVPD som stöder enkel inloggning. Om inga MVPD-program stöder enkel inloggning används det klassiska autentiseringsflödet.

När användaren har valt en provider anropas status()-återanropet. En registreringskod kommer att anges och AccessEnabler-biblioteket börjar avfråga servern för att erhålla en andra skärmautentisering.

Om den angivna registreringskoden användes för att autentisera på den andra skärmen aktiveras setAuthenticatiosStatus()-återanropet. Nu bör användaren autentiseras med Apple SSO.

[Valfritt] samtal checkPreauthorizedResources(resources) för att kontrollera vilka resurser användaren har behörighet att visa. Parametern resources är en matris med skyddade resurser som är associerad med användarens autentiseringstoken. En användning för auktoriseringsinformation som hämtas från användarens MVPD är att dekorera användargränssnittet (t.ex. låsta/olåsta symboler bredvid skyddat innehåll).

• Utlösare: preauthorizedResources() återanrop

• Körningspunkt: Efter det slutförda autentiseringsflödet

Om autentiseringen lyckades fortsätter du till auktoriseringsflödet.

Anropa getAuthorization() för att initiera auktoriseringsflödet.

• Beroende: Giltiga resurs-ID:n som har avtalats med MVPD:n.
• Resurs-ID:n ska vara samma som de som används på andra enheter eller plattformar och ska vara samma för alla programmeringsgränssnitten. Mer information om resurs-ID:n finns i Identifiera skyddade resurser

Validera autentisering och auktorisering.

• Om anropet getAuthorization() lyckas: Användaren har giltiga AuthN- och AuthZ-tokens (användaren är autentiserad och har behörighet att titta på det begärda mediet).

• Om getAuthorization() misslyckas: Undersök undantaget som utlöses för att fastställa dess typ (AuthN, AuthZ eller något annat):

  • Om det var ett autentiseringsfel (AuthN) startar du om autentiseringsflödet.
  • Om det var ett auktoriseringsfel (AuthZ) har användaren inte behörighet att titta på det begärda mediet och någon typ av felmeddelande ska visas för användaren.
  • Om det finns någon annan typ av fel (anslutningsfel, nätverksfel osv.) visar sedan ett felmeddelande för användaren.

Validera den korta medietoken.
Använd Adobe Pass Authentication Media Token Verifier-biblioteket för att verifiera den kortlivade medietoken som returneras från getAuthorization() -anropet ovan:

• Om valideringen lyckas: Spela upp det begärda mediet för användaren.
• Om valideringen misslyckas: AuthZ-token var ogiltig, ska mediebegäran avvisas och ett felmeddelande ska visas för användaren.

Återgå till det normala programflödet.

Användaren väljer de media som ska visas.

Är mediet skyddat? Programmet kontrollerar om det valda mediet är skyddat:

• Om det valda mediet är skyddat startar programmet auktoriseringsflödet ovan.

• Om det valda mediet inte är skyddat kan du spela upp mediet för
  användaren.

Ring logout() för att logga ut användaren. AccessEnabler rensar bort alla cachelagrade värden och token. När cacheminnet har rensats gör AccessEnabler ett serveranrop för att rensa sessionerna på serversidan. Observera, att eftersom serveranropet kan resultera i en SAML-omdirigering till IdP (detta tillåter sessionsrensning på IdP-sidan), måste det här anropet följa alla omdirigeringar. Därför måste anropet hanteras inuti en UIWebView/WKWebView- eller SFSafariViewController-styrenhet.

a. Om du följer samma mönster som autentiseringsarbetsflödet skickar AccessEnabler-domänen en en begäran till UI-programlagret, via navigateToUrl: eller navigateToUrl:useSVC: callback, om att skapa en UIWebView-/WKWebView- eller SFSafariViewController-styrenhet och instruerar dig att läsa in URL:en som finns i callback-parametern url . Det här är URL:en för utloggningsslutpunkten på backend-servern.

b. Programmet måste övervaka aktiviteten för UIWebView/WKWebView or SFSafariViewController-kontrollanten och identifiera tidpunkten då en viss anpassad URL läses in, eftersom den går igenom flera omdirigeringar. Observera att den här anpassade URL:en är ogiltig och inte avsedd för att styrenheten ska läsa in den. Det får bara tolkas av programmet som en signal om att utloggningsflödet har slutförts och att det är säkert att stänga UIWebView/WKWebView- eller SFSafariViewController-kontrollen. När kontrollenheten läser in den här anpassade URL:en måste programmet stänga UIWebView/WKWebView or SFSafariViewController-kontrollenheten och anropa AccessEnablers handleExternalURL:urlAPI-metod. Om en SFSafariViewController-kontrollant måste användas definieras den anpassade URL:en av application's custom scheme (till exempel adbe.u-XFXJeTSDuJiIQs0HVRAg://adobe.com), annars definieras den här anpassade URL:en av konstanten ADOBEPASS_REDIRECT_URL (dvs. adobepass://ios.app).