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

wint cliëntgeloofsbrieven terug: de het stromen toepassing wint cliëntgeloofsbrieven door het /o/client/register eindpunt te roepen.

• De streamingtoepassing moet de clientgegevens opslaan en deze onbeperkt gebruiken wanneer een toegangstoken moet worden opgehaald.

wint toegangstoken terug: de het stromen toepassing wint toegangstoken terug door het /o/client/token eindpunt te roepen.

• De streamingtoepassing moet het toegangstoken opslaan en gebruiken tot het verloopt, het vervolgens verwijderen en een nieuw token verkrijgen.

wint profielen terug: de het stromen toepassing controleert bestaande profielen door het /api/v2/ {serviceProvider} /profiles eindpunt te roepen.

Scenario 1: er zijn bestaande profielen, kan de het stromen toepassing aan de ​ VoorkeurFase ​ of ​ Fase van de Toestemming ​ te werk gaan.

Scenario 2: Er zijn geen bestaande profielen, kan de het stromen toepassing aan de volgende stap te werk gaan ​ de gebruiker ​ voor authentiek verklaren.

Scenario 3: Er zijn geen bestaande profielen, kan de het stromen toepassing 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 het stromen toepassing wint de lijst van beschikbare MVPDs door het /api/v2/ {serviceProvider}/configuration eindpunt te roepen.

• De het stromen toepassing kan een douane filtrerend mechanisme uitvoeren om de lijst van MVPDs van de configuratiereactie te verfijnen, die 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 het stromen toepassing stelt een authentificatiesessie door het /api/v2/ {serviceProvider} in werking te roepen/zittingen eindpunt.

Scenario 1: de het stromen toepassing 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: de het stromen toepassing 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 het stromen toepassing 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 het stromen toepassing moet beginnen het opiniepeilings mechanisme onder de volgende voorwaarden:

  • Authentificatie die binnen de primaire (scherm) toepassing wordt uitgevoerd: de primaire (het stromen) toepassing zou moeten beginnen opiniepeilend 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 primaire (het stromen) toepassing 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 het stromen toepassing 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 het stromen toepassing moet de opiniepeilende mechanismefrequentie onder de volgende voorwaarden vormen:

  • Authentificatie die binnen de primaire (scherm) toepassing wordt uitgevoerd: de primaire (het stromen) toepassing zou elke 3-5 seconden of meer moeten opiniepeilen.

  • Authentificatie die binnen een secundaire (scherm) toepassing wordt uitgevoerd: de primaire (het stromen) toepassing zou elke 3-5 seconden of meer moeten opiniepeilen.

• De streamingtoepassing moet delen van de profielgegevens van de gebruiker in een permanente opslag in cache plaatsen om onnodige aanvragen te voorkomen en de gebruikerservaring te verbeteren.

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

• De streamingtoepassing is niet vereist voor het opslaan van beslissingen voorafgaand aan de autorisatie 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 het stromen toepassing 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 streamingtoepassing kan een voorafgaande beslissing voor een beperkt aantal bronnen verkrijgen in één API-aanvraag, meestal maximaal 5, als gevolg van voorwaarden die door de MVPD's 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 het stromen toepassing wint vergunningsbesluit voor een specifiek middel door /api/v2/ {serviceProvider}/Decision/authorize/{mvpd} eindpunt te roepen.

• De streamingtoepassing is niet vereist voor het opslaan van beslissingen over machtigingen in permanente opslag.

• De het stromen toepassing 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 details geven inzicht in de specifieke reden waarom de aanvraag voor een vergunning is afgewezen, waardoor de gebruikerservaring kan worden geïnformeerd of een noodzakelijke afhandeling in de toepassing kan worden gestart. 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 streamingtoepassing is niet vereist om een verlopen mediatoken te vernieuwen terwijl de stream actief wordt afgespeeld. 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 streamingtoepassing kan een machtigingsbesluit voor een beperkt aantal bronnen verkrijgen in één API-aanvraag, meestal maximaal 1, als gevolg van voorwaarden die door MVPD's worden opgelegd.

stelt Adobe Pass logout in werking: de het stromen toepassing stelt de logout stroom door in werking te roepen/api/v2/ {serviceProvider} /logout/{mvpd} eindpunt.

• De streamingtoepassing 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 logout-proces correct is voltooid.

  • Als het kenmerk actionType in het antwoord is ingesteld op "interactive":

    • Scenario 1: de het stromen toepassing kan browser of webmening openen, daarom moet het logout url laden.

    • Scenario 2: de het stromen toepassing kan geen browser openen, daarom kan het logout proces worden tegengehouden aangezien de zitting van MVPD niet in het geheime voorgeheugen van een het stromen apparatenbrowser werd voortgeduurd.