REST API V2 Cookbook (Server-to-Server) rest-api-v2-cookbook-server-to-server

Communiceer met Adobe Pass Service namens de Streaming App.

Verzamel en ga een uniek apparatenherkenningsteken voor het Streamen Apparaat zoals die door ​ wordt vereist AP-Apparaat-Herkenningsteken ​ kopbal over.

Verzamel en ga nauwkeurige het Stromen informatie van het Apparaat, met inbegrip van de bronhaven en apparaat-specifieke details, zoals die door ​ x-apparaat-Info ​ kopbal worden vereist.

Verzamel en geef het IP-adres van het Streaming apparaat door zoals vereist door de X-Forwarded-For header.

Sla parameters zoals apparaat-id, client-id en clientgeheim op in de Streaming-app of de Programmer-service.

Gegevens opmaken en verzenden in overeenstemming met MVPD's en geïntegreerde apps, waaronder apparaat-IP, bronpoort, apparaatspecifieke informatie, MRSS en optionele id's zoals ECID.

Certificaten onderhouden en veilig beheren die met Adobe worden gedeeld voor de verzending van gecodeerde metagegevens van gebruikers.

Het verificatieprofiel en de geldigheid van het autorisatiebesluit respecteren wanneer caching, het waarborgen van authenticatie en autorisatiestatus ongeldig worden gemaakt wanneer kennisgeving wordt gedaan.

Retourvergunningsbesluiten en relevante instructies voor de Streaming App.

De Adobe Pass Service werkt in meerdere geografisch verspreide datacenters in de VS om de prestaties te optimaliseren en de latentie te minimaliseren.

• De Programmeringsservice moet een vergelijkbare infrastructuurstrategie volgen, waarbij de responstijden voor lage latentie van Adobe Pass worden gewaarborgd.

De programmeur moet de openbare IP waaier van zijn productiemilieu verstrekken.

• Deze IPs zal aan een lijst van gewenste personen binnen de Infrastructuur van Adobe Pass worden toegevoegd.

De dienst van de Programmer moet DNS caching tot maximaal 30 seconden beperken om voor dynamische het verpletteren toe te staan voor het geval Adobe verkeer moet omleiden omdat een gegevenscentrum niet beschikbaar wordt.

Het moet testversies mogelijk maken voordat het product in productie wordt genomen.

Het moet operationeel vergelijkbaar blijven met de productie, zodat realistische tests mogelijk zijn.

In het ideale geval moet de testomgeving worden verbonden met Adobe Pass-testomgevingen met:

• Sta Programmeurs toe om tegen de Infrastructuur van Adobe te testen.

• Schakel Adobe in als hulp bij het testen en oplossen van problemen.

Haal cliëntgeloofsbrieven terug: De Dienst van de Programmer wint cliëntgeloofsbrieven door het /o/client/register eindpunt te roepen.

• De Programmerservice of Programmerer App moet de clientgegevens opslaan en deze onbeperkt gebruiken wanneer u een toegangstoken moet ophalen.

Haal toegangstoken terug: De Dienst van de Programmer wint toegangstoken door het /o/client/token eindpunt te roepen.

• De Dienst van de Programmer of App van de Programmer moet het toegangstoken opslaan en gebruiken tot het verloopt, dan verwerpen het en verkrijgen nieuwe.

wint profielen terug: de Controle van de Dienst van de Programmer namens Streaming App voor bestaande profielen door het /api/v2/ {serviceProvider} /profiles eindpunt te roepen.

Scenario 1: Er zijn bestaande profielen, kan de Dienst van de Programmer aan de ​ Voorbereidende Fase ​ of ​ Fase van de Toestemming ​ te werk gaan.

Scenario 2: Er zijn geen bestaande profielen, kan de Dienst van de Programmer aan de volgende stap te werk gaan ​ de gebruiker ​ voor authentiek verklaren.

Scenario 3: Er zijn geen bestaande profielen, kan de Dienst van de Programmer te werk gaan om de gebruiker van tijdelijke toegang door de ​ TempPass ​ eigenschap te voorzien.

• Dit scenario is buiten het werkingsgebied van dit document, verwijs naar de ​ Tijdelijke documentatie van de Stromen van de Toegang ​ voor meer informatie.

wint configuratie terug: De Dienst van de Programmer wint de lijst van beschikbare MVPDs door het /api/v2/ {serviceProvider}/configuration eindpunt te roepen.

• De dienst van de Programmer kan een douane filtrerend mechanisme uitvoeren om de lijst van MVPDs van de configuratiereactie te verfijnen, zodat de Streaming App slechts de voorgenomen leveranciers toont terwijl het verbergen van anderen (b.v., MVPDs in ontwikkeling, test MVPDs, TempPass). Op deze manier weet u zeker dat gebruikers een curatieve selectie krijgen wanneer ze hun tv-provider kiezen.

creeer authentificatiesessie: De Dienst van de Programmer stelt een authentificatiesessie door het /api/v2/ {serviceProvider} /sessies eindpunt te roepen.

• De programmeerservice moet de code en url retourneren naar de streamingtoepassing.

Scenario 1: Streaming App kan browser of webmening openen, daarom moet het de authentificatie url laden.

• De gebruiker verzendt zijn gebruikersnaam en wachtwoord binnen de MVPD aanmeldingspagina. Bij geslaagde verificatie wordt een succespagina weergegeven met de uiteindelijke omleiding.

Scenario 2: Streaming App kan geen browser openen, daarom moet het de authentificatie code tonen. Een afzonderlijke Webtoepassing wordt vereist om de gebruiker ertoe aan te zetten om code in te gaan, de authentificatie url te construeren en te openen: /api/v2/authenticate/{serviceProvider}/{code}.

• De gebruiker verzendt zijn gebruikersnaam en wachtwoord binnen de MVPD aanmeldingspagina. Bij geslaagde verificatie wordt een succespagina weergegeven met de uiteindelijke omleiding.

wint profiel voor specifieke code terug: De Dienst van de Programmer moet een opiniepeilingsmechanisme uitvoeren gebruikend code om te controleren of werd het profiel met succes geproduceerd en bewaard door /api/v2/ {serviceProvider} /profiles/code/{code} eindpunt te roepen.

• De dienst van de Programmer moet het opiniepeilings mechanisme onder de volgende voorwaarden beginnen:

  • Authentificatie die binnen de primaire (scherm) toepassing wordt uitgevoerd: De Dienst van de Programmer zou moeten beginnen te pollen wanneer de gebruiker de definitieve bestemmingspagina bereikt, nadat de browser component URL laadt die voor de redirectUrl parameter in het ​ wordt gespecificeerd Sessions ​ eindpuntverzoek.

  • Authentificatie die binnen een secundaire (scherm) toepassing wordt uitgevoerd: de toepassing van de Dienst van de Programmer zou moeten beginnen opiniepeilend zodra de gebruiker het authentificatieproces-recht na het ontvangen van de ​ 3} eindpuntreactie van Zittingen {en het tonen van de authentificatiecode aan de gebruiker in werking stelt.

• De dienst van de Programmer moet het opiniepeilings mechanisme onder de volgende voorwaarden tegenhouden:

  • Succesvolle authentificatie: de het profielinformatie van de gebruiker wordt met succes teruggewonnen, bevestigend hun authentificatiestatus. Op dit moment is opiniepeiling niet langer nodig.

  • de zitting van de Authentificatie en de codereduur: de authentificatiesessie en de code verlopen, zoals die door notAfter wordt vermeld timestamp (b.v., 30 minuten) in de ​ 4} eindpuntreactie van Zittingen {. ​ Als dit gebeurt, moet de gebruiker het authentificatieproces opnieuw beginnen, en de opiniepeiling die de vorige authentificatiecode gebruikt zou onmiddellijk moeten worden tegengehouden.

  • Nieuwe geproduceerde authentificatiecode: als de gebruiker om een nieuwe authentificatiecode op het primaire (scherm) apparaat verzoekt, is de bestaande zitting niet meer geldig, en de opiniepeiling die de vorige authentificatiecode gebruikt zou onmiddellijk moeten worden tegengehouden.

• De dienst van de Programmer moet de opiniepeilings mechanismefrequentie onder de volgende voorwaarden vormen:

  • Authentificatie die binnen de primaire (scherm) toepassing wordt uitgevoerd: de Dienst van de Programmer zou om de 3-5 seconden of meer moeten opiniepeilen.

  • Authentificatie die binnen een secundaire (scherm) toepassing wordt uitgevoerd: de Dienst van de Programmer zou om de 3-5 seconden of meer moeten opiniepeilen.

• De programmeerservice moet onderdelen van de profielgegevens van de gebruiker in een permanente opslag in cache plaatsen om onnodige verzoeken te voorkomen en de gebruikerservaring te verbeteren.

wint pre-vergunningsbesluiten terug: De Dienst van de Programmer wint pre-vergunningsbesluiten voor een lijst van middelen door /api/v2/ {serviceProvider}/decisions/preAuthze/{mvpd} eindpunt te roepen.

• De Programmeringsdienst moet de lijst van vergunning overgaan en pre-vergunningsbesluiten aan de Streaming App ontkennen.

• De Programmer Service is niet verplicht om beslissingen vóór de goedkeuring op te slaan in permanente opslag. Nochtans, wordt het geadviseerd om vergunningsbesluiten in het voorgeheugen op te slaan om de gebruikerservaring te verbeteren. Dit helpt onnodige vraag naar middelen vermijden die reeds vooraf zijn geautoriseerd, die latentie verminderen en prestaties verbeteren.

• De dienst van de Programmeur kan de reden voor een ontkend pre-vergunningsbesluit bepalen door de ​ foutencode en het bericht ​ te inspecteren inbegrepen in de reactie van Besluiten pre-goedkeurt eindpunt. Deze details geven inzicht in de specifieke reden waarom de aanvraag voor voorafgaande toestemming is afgewezen, waardoor de gebruikerservaring kan worden geïnformeerd of de benodigde afhandeling in de toepassing kan worden geactiveerd. Ervoor zorgen dat elk nieuw mechanisme dat wordt toegepast voor het ophalen van beslissingen vóór toelating, niet in een eindeloze lus resulteert als het besluit vóór toelating wordt geweigerd. U kunt overwegen om pogingen tot een redelijk aantal te beperken en weigeringen netjes af te handelen door duidelijke feedback aan de gebruiker te bekijken.

• De Programmeringsdienst kan een voorafgaande vergunningsbesluit voor een beperkt aantal middelen in één enkel API verzoek, gewoonlijk tot 5, wegens voorwaarden verkrijgen die door MVPDs worden opgelegd. Dit maximumaantal middelen kan worden bekeken en veranderd na het akkoord gaan met MVPDs door het Dashboard van Adobe Pass ​ TVE ​ door één van uw organisatiebeheerders of door een vertegenwoordiger van de Authentificatie van Adobe Pass handelend namens u.

wint vergunningsbesluit terug: De Dienst van de Programmer wint vergunningsbesluit voor een specifiek middel terug door de Streaming App door /api/v2/ {serviceProvider} /Decision/authorize/{mvpd} eindpunt te roepen.

• De Programmer Service is niet verplicht om beslissingen over machtigingen in permanente opslag op te slaan.

• De dienst van de Programmer kan de reden voor een ontkend vergunningsbesluit bepalen door de ​ foutencode en het bericht ​ te inspecteren inbegrepen in de reactie van Besluiten machtigt eindpunt. Deze gegevens verschaffen insight de specifieke reden waarom de aanvraag voor een vergunning is afgewezen, zodat de gebruiker op de hoogte kan worden gebracht van de ervaring of de benodigde afhandeling in de Streaming App kan worden geactiveerd. Ervoor zorgen dat een nieuw mechanisme dat wordt toegepast voor het ophalen van vergunningsbesluiten niet in een eindeloze lus resulteert als het vergunningsbesluit wordt geweigerd. U kunt overwegen om pogingen tot een redelijk aantal te beperken en weigeringen netjes af te handelen door duidelijke feedback aan de gebruiker te bekijken.

• De programmeerdienst kan andere bedrijfsregels evalueren en een passend vergunningsbesluit aan de Streaming App teruggeven.

• De dienst van de Programmer wordt niet vereist om een verlopen media teken te verfrissen terwijl de stroom actief speelt. Als het media-token tijdens het afspelen verloopt, moet het zijn toegestaan dat de stream zonder onderbreking wordt voortgezet. Nochtans, moet de cliënt om een nieuw vergunningsbesluit verzoeken — en een nieuw media teken verkrijgen — de volgende tijd de gebruiker probeert om een middel te spelen.

• De programmeerservice kan een vergunningsbesluit voor een beperkt aantal bronnen verkrijgen in één API-aanvraag, meestal maximaal 1, als gevolg van voorwaarden die door de MVPD's worden opgelegd.

Initieer Adobe Pass logout: De Dienst van de Programmer stelt de logout stroom zoals gevraagd door de Streaming App in werking door het /api/v2/ {serviceProvider}/logout/{mvpd} ​ eindpunt te roepen.

• De Programmeringsservice kan alle informatie opruimen die deze over de geverifieerde gebruiker opslaat.

• De Programmeringsservice moet de instructies volgen die in de kenmerken actionName en actionType van de eindpuntreactie bij de aanmelding zijn opgegeven, om ervoor te zorgen dat het aflogproces correct is voltooid.

  • Als het kenmerk actionType in het antwoord is ingesteld op "interactief", moet de Programmer Service de waarde van het kenmerk url retourneren naar de Streaming App.

    • Scenario 1: Streaming App kan browser of webmening openen, daarom moet het logout url laden.

    • Scenario 2: Streaming App kan geen browser openen, daarom kan het logout proces worden tegengehouden aangezien de zitting van MVPD niet in browser van het Streaming Apparaat geheim voorgeheugen werd gehouden.