REST API V2 Cookbook (klient-till-server) rest-api-v2-cookbook-client-to-server

Hämta klientautentiseringsuppgifter: Direktuppspelningsprogrammet hämtar klientautentiseringsuppgifter genom att anropa slutpunkten /o/client/register.

• Strömningsprogrammet måste lagra klientens autentiseringsuppgifter och använda dem i oändlighet när en åtkomsttoken behöver hämtas.

Hämta åtkomsttoken: Direktuppspelningsprogrammet hämtar åtkomsttoken genom att anropa slutpunkten /o/client/token.

• Strömningsprogrammet måste lagra och använda åtkomsttoken tills den upphör att gälla, sedan ta bort den och skaffa en ny.

Hämta profiler: Direktuppspelningsprogrammet söker efter befintliga profiler genom att anropa slutpunkten /api/v2/{serviceProvider}/profiles .

Scenario 1: Det finns befintliga profiler. Strömningsprogrammet kan fortsätta till förauktoriseringsfasen eller auktoriseringsfasen.

Scenario 2: Det finns inga befintliga profiler. Direktuppspelningsprogrammet kan fortsätta till nästa steg för att autentisera användaren.

Scenario 3: Det finns inga befintliga profiler. Direktuppspelningsprogrammet kan fortsätta att ge användaren tillfällig åtkomst via funktionen TempPass.

• Det här scenariot ligger utanför det här dokumentets omfång. Mer information finns i dokumentationen för Tillfälliga åtkomstflöden.

Hämta konfiguration: Direktuppspelningsprogrammet hämtar listan över tillgängliga MVPD-filer genom att anropa slutpunkten /api/v2/{serviceProvider}/configuration .

• Strömningsprogrammet kan implementera en anpassad filtreringsmekanism för att förfina listan över MVPD-program från konfigurationssvaret och endast visa avsedda providers medan andra döljs (t.ex. MVPD-program under utveckling, test MVPD-program, TempPass). Detta garanterar att användarna får ett välstrukturerat urval när de väljer sin tv-leverantör.

Skapa autentiseringssession: Direktuppspelningsprogrammet initierar en autentiseringssession genom att anropa slutpunkten /api/v2/{serviceProvider}/sessions.

Scenario 1: Direktuppspelningsprogrammet kan öppna en webbläsare eller webbvy, och därför måste autentiseringen url läsas in.

• Användaren anger sitt användarnamn och lösenord på inloggningssidan för MVPD. När autentiseringen är klar visas en sida för slutförd omdirigering.

Scenario 2: Direktuppspelningsprogrammet kan inte öppna en webbläsare och autentiseringen code måste därför visas. Ett separat webbprogram krävs för att uppmana användaren att ange code, konstruera autentiseringen url och öppna: /api/v2/authenticate/{serviceProvider}/{code}.

• Användaren anger sitt användarnamn och lösenord på inloggningssidan för MVPD. När autentiseringen är klar visas en sida för slutförd omdirigering.

Hämta profil för specifik kod: Direktuppspelningsprogrammet måste implementera en avsökningsmekanism med code för att kontrollera om profilen genererades och sparades genom att anropa slutpunkten /api/v2/{serviceProvider}/profiles/code/{code}.

• Direktuppspelningsprogrammet måste starta avsökningsfunktionen under följande förhållanden:

  • Autentisering som utförs i det primära (skärm) programmet: Det primära (direktuppspelande) programmet ska starta avsökningen när användaren kommer till den sista målsidan, efter att webbläsarkomponenten har läst in den URL som angetts för parametern redirectUrl i Sessions -slutpunktsbegäran.

  • Autentisering som utförs i ett sekundärt (skärm) program: Det primära (direktuppspelande) programmet ska starta avsökningen så snart användaren initierar autentiseringsprocessen - direkt efter att ha tagit emot Sessioner -slutpunktssvaret och visar autentiseringskoden för användaren.

• Direktuppspelningsprogrammet måste stoppa avsökningsfunktionen under följande förhållanden:

  • Autentiseringen är klar: Användarens profilinformation har hämtats och autentiseringsstatusen har bekräftats. I nuläget behövs ingen avsökning längre.

  • Autentiseringssession och förfallodatum för kod: Autentiseringssessionen och koden förfaller, vilket anges av tidsstämpeln notAfter (t.ex. 30 minuter) i slutpunktssvaret för sessioner. Om detta inträffar måste användaren starta om autentiseringsprocessen och avsökningen med den tidigare autentiseringskoden ska stoppas omedelbart.

  • Ny autentiseringskod har genererats: Om användaren begär en ny autentiseringskod på den primära (skärm) enheten är den befintliga sessionen inte längre giltig och avsökningen med den tidigare autentiseringskoden bör stoppas omedelbart.

• Direktuppspelningsprogrammet måste konfigurera avsökningsfrekvensen under följande förhållanden:

  • Autentisering som utförs i det primära (skärm) programmet: Det primära (direktuppspelande) programmet ska avsöka var 3:e till 5:e sekund eller mer.

  • Autentisering som utförs i ett sekundärt (skärm) program: Det primära (direktuppspelande) programmet ska avsöka var 3-5:e sekund eller mer.

• Strömningsprogrammet bör cachelagra delar av användarens profilinformation i en beständig lagringsplats för att undvika onödiga begäranden och förbättra användarupplevelsen.

Hämta beslut om förauktorisering: Direktuppspelningsprogrammet hämtar beslut om förauktorisering för en lista med resurser genom att anropa slutpunkten /api/v2/{serviceProvider}/Decision/preauthorized/{mvpd} .

• Strömningsprogrammet behövs inte för att lagra förauktoriseringsbeslut i beständig lagring. Vi rekommenderar dock att du cachelagrar tillståndsbeslut i minnet för att förbättra användarupplevelsen. På så sätt undviker du onödiga krav på resurser som redan har förauktoriserats, vilket minskar latensen och förbättrar prestandan.

• Direktuppspelningsprogrammet kan fastställa orsaken till ett beslut om förauktorisering som nekas genom att granska felkoden och meddelandet som ingår i svaret från slutpunkten för förauktorisering av beslut. Dessa detaljer ger insikt i den specifika anledningen till att förauktoriseringsbegäran nekades, vilket kan hjälpa användaren att informera om användarupplevelsen eller utlösa nödvändig hantering i programmet. Se till att alla återförsöksmetoder som implementeras för att hämta beslut om förauktorisering inte resulterar i en oändlig slinga om beslutet om förauktorisering nekas. Överväg att begränsa antalet försök till ett rimligt antal och hantera nekanden på ett enkelt sätt genom att ge användaren tydlig feedback.

• Strömningsprogrammet kan få ett beslut om förhandsgodkännande för ett begränsat antal resurser i en enda API-begäran, vanligtvis upp till 5, på grund av villkor som anges av distributörer av videoprogrammeringstjänster. Det maximala antalet resurser kan visas och ändras efter att du har godkänt PDF-filer via Adobe Pass TVE Dashboard av en av organisationens administratörer eller av en Adobe Pass-autentiseringsrepresentant som agerar för din räkning.

Hämta auktoriseringsbeslut: Direktuppspelningsprogrammet hämtar auktoriseringsbeslut för en specifik resurs genom att anropa slutpunkten /api/v2/{serviceProvider}/Decision/authorized/{mvpd}.

• Strömningsprogrammet behövs inte för att lagra auktoriseringsbeslut i beständig lagring.

• Direktuppspelningsprogrammet kan fastställa orsaken till ett beslut om nekad auktorisering genom att granska felkoden och meddelandet som ingår i svaret från verifieringsslutpunkten för beslut. Dessa uppgifter ger insikt i varför auktoriseringsbegäran nekades, vilket kan bidra till att informera användaren eller utlösa nödvändig hantering i programmet. Se till att alla återförsöksmetoder som implementeras för att hämta auktoriseringsbeslut inte resulterar i en oändlig slinga om auktoriseringsbeslutet nekas. Överväg att begränsa antalet försök till ett rimligt antal och hantera nekanden på ett enkelt sätt genom att ge användaren tydlig feedback.

• Direktuppspelningsprogrammet behöver inte uppdatera en medietoken som har upphört att gälla medan direktuppspelningen pågår. Om medietoken upphör att gälla under uppspelning bör strömmen kunna fortsätta utan avbrott. Klienten måste dock begära ett nytt auktoriseringsbeslut - och få en ny medietoken - nästa gång användaren försöker spela upp en resurs.

• Strömningsprogrammet kan erhålla ett auktoriseringsbeslut för ett begränsat antal resurser i en enda API-begäran, vanligtvis upp till 1, på grund av villkor som anges av distributörer av videoprogrammeringstjänster.

Initiera Adobe Pass-utloggning: Strömningsprogrammet initierar utloggningsflödet genom att anropa slutpunkten /api/v2/{serviceProvider}/logout/{mvpd}.

• Direktuppspelningsprogrammet måste följa instruktionerna i attributen actionName och actionType för slutpunktssvaret för utloggning för att säkerställa att utloggningsprocessen slutförs korrekt.

  • Om attributet actionType i svaret är inställt på "interaktiv":

    • Scenario 1: Direktuppspelningsprogrammet kan öppna en webbläsare eller webbvy och måste därför läsa in utloggningen url.

    • Scenario 2: Direktuppspelningsprogrammet kan inte öppna en webbläsare, och därför kan utloggningsprocessen stoppas eftersom MVPD-sessionen inte sparades i en webbläsarcache för direktuppspelningsenheten.