REST API V2 Checklist rest-api-v2-checklist

Vereisten

Risico's

Gebruik een geregistreerde toepassing met REST API v2-bereik.

Risico's die HTTP 401 "Onbevoegde"foutenreacties teweegbrengen, systeemmiddelen overbelasten en latentie verhogen.

Sla de clientgegevens op in permanente opslag en hergebruik deze voor elk verzoek om een toegangstoken.

Riseert authentificatieverlies wanneer de cliëntgeloofsbrieven opnieuw worden geproduceerd.

Sla de toegangstokens op in permanente opslag en gebruik ze opnieuw tot ze verlopen.

verzoek geen nieuw teken voor elke REST API v2 vraag, vernieuw de toegangstokens slechts wanneer zij verlopen.

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

Vereisten

Risico's

Haal de configuratiereactie alleen op wanneer u de gebruiker moet vragen zijn of haar MVPD (tv-provider) te selecteren voordat de verificatiefase plaatsvindt.

Er is geen behoefte om de configuratiereactie terug te winnen wanneer:

• De gebruiker is al geverifieerd.
• De gebruiker krijgt tijdelijk toegang.
• De gebruikersverificatie is verlopen, maar de gebruiker kan worden gevraagd te bevestigen dat hij of zij nog steeds een abonnee is van de eerder geselecteerde MVPD.

Risico's bij het overladen van systeembronnen en het vergroten van de latentie.

Sla de selectie van de Pay TV provider (MVPD) van de gebruiker op in blijvende opslag om deze in alle volgende fasen te gebruiken:

• In het reactiebestand van de configuratie slaat de gebruiker de MVPD-id op.
• Vanuit configuratierespons slaat de gebruiker MVPD "displayName" op.
• Vanuit de configuratiereactie slaat u de gebruiker MVPD "logoUrl" op.

Risico's bij het overladen van systeembronnen en het vergroten van de latentie.

Vereisten

Risico's

Begin het opiniepeilingsmechanisme onder de volgende voorwaarden:

Authentificatie die binnen de primaire (scherm) toepassing wordt uitgevoerd

• De primaire (het stromen) toepassing zou moeten beginnen opiniepeiling wanneer de gebruiker de definitieve bestemmingspagina bereikt, nadat de browser component URL laadt die voor de "redirectUrl"parameter in het het eindpuntverzoek van Sessies wordt gespecificeerd.

Authentificatie die binnen een secundaire (scherm) toepassing wordt uitgevoerd

• De primaire (het stromen) toepassing zou moeten beginnen opiniepeiling zodra de gebruiker het authentificatieproces-recht na het ontvangen van de het eindpuntreactie van Sessies en het tonen van de authentificatiecode aan de gebruiker in werking stelt.

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

Stop het opiniepeilingsmechanisme onder de volgende voorwaarden:

Succesvolle authentificatie

• De het profielinformatie van de gebruiker wordt met succes teruggewonnen, bevestigend hun authentificatiestatus, daarom is de opiniepeiling niet meer nodig.

de zitting van de Authentificatie en coderepering

• De verificatiesessie en de code verlopen, de gebruiker moet het verificatieproces opnieuw starten en de opiniepeiling met de vorige verificatiecode moet onmiddellijk worden gestopt.

Nieuwe geproduceerde authentificatiecode

• Als de gebruiker om een nieuwe authentificatiecode verzoekt, dan wordt de bestaande zitting ongeldig gemaakt, en de opiniepeiling die de vorige authentificatiecode gebruikt zou onmiddellijk moeten worden tegengehouden.

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

Vorm de frequentie van het opiniepeilingsmechanisme onder de volgende voorwaarden:

Authentificatie die binnen de primaire (scherm) toepassing wordt uitgevoerd

• De primaire (het stromen) toepassing zou om de 3-5 seconden of meer moeten opiniepeilen.

Authentificatie die binnen een secundaire (scherm) toepassing wordt uitgevoerd

• De primaire (het stromen) toepassing zou om de 3-5 seconden moeten opiniepeilen.

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

Sla delen van de profielgegevens van de gebruiker op in permanente opslag om de prestaties te verbeteren en onnodige REST API v2-aanroepen tot een minimum te beperken.

Caching zou op de volgende gebieden van de profielreactie moeten concentreren:

mvpd

• De clienttoepassing kan dit gebruiken om de geselecteerde tv-provider van de gebruiker bij te houden en deze verder te blijven gebruiken tijdens de fase voorafgaand aan autorisatie of autorisatie.
• Wanneer het huidige gebruikersprofiel is verlopen, kan de clienttoepassing de onthouden MVPD-selectie gebruiken en de gebruiker vragen dit te bevestigen.

attributen

• Wordt gebruikt om de gebruikerservaring aan te passen op basis van verschillende metagegevens van de gebruiker (bijvoorbeeld zip, maxRating, enz.).
• De meta-gegevens van de gebruiker worden beschikbaar nadat de authentificatiestroom voltooit, daarom te hoeven de cliënttoepassing niet om een afzonderlijk eindpunt te vragen om de informatie van gebruikersmeta-gegevens terug te winnen, aangezien het reeds inbegrepen in de profielinformatie is.
• Bepaalde metagegevenskenmerken kunnen tijdens de machtigingsfase worden bijgewerkt, afhankelijk van de MVPD (bv. het Handvest) en het specifieke metagegevenskenmerk (bv. de huisnummer). Het gevolg is dat de clienttoepassing mogelijk opnieuw een query moet uitvoeren op de API's voor profielen nadat de laatste metagegevens van de gebruiker zijn opgehaald.

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

Vereisten

Risico's

Gebruik beslissingen vóór toelating voor filteren van inhoud en nooit voor afspeelbeslissingen.

Risico's die in strijd zijn met contractuele overeenkomsten tussen programmeur, MVPD en Adobe.

de risico's die onze controle en alarmerende systemen omzeilen.

Behandel verbeterde foutencodesgeschikt en gebruik het actieveld om de noodzakelijke saneringsstappen te bepalen.

slechts een beperkt aantal verbeterde foutencodes rechtvaardigen een herpoging, terwijl de meesten alternatieve resoluties zoals gespecificeerd in het actieveld vereisen.

zorg ervoor dat om het even welk die retry mechanisme voor het terugwinnen van pre-vergunningsbesluiten wordt uitgevoerd niet in een eindeloze lijn resulteert en dat het probeert tot een redelijk aantal beperkt (d.w.z., 2-3).

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

Plaats geslaagde vergunningsbeslissingen in het geheugen om de prestaties te verbeteren en onnodige REST API v2-aanroepen tot een minimum te beperken, aangezien abonnementsupdates tijdens het uitvoeren van de toepassing niet vaak worden uitgevoerd.

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

Vereisten

Risico's

Geef autorisatiebeslissingen op voordat u gaat afspelen, ongeacht of er een voorafgaande autorisatiebeslissing bestaat.

staat stromen toe om ononderbroken voort te zetten zelfs als het media teken tijdens playback verloopt en om een nieuw vergunningsbesluit verzoeken die (vers) media teken bevatten wanneer de gebruiker hun volgende playbackverzoek maakt, ongeacht het voor het zelfde of een verschillend middel is.

Levende stromen die voor langere periodes lopen kunnen verkiezen om een nieuw vergunningsbesluit na videoverrichtingen zoals het pauzeren van inhoud, het in werking stellen van commerciële onderbrekingen, of het wijzigen van activa-vlakke configuraties te verzoeken wanneer MRSS veranderingen ondergaat.

Risico's die in strijd zijn met contractuele overeenkomsten tussen programmeur, MVPD en Adobe.

de risico's die onze controle en alarmerende systemen omzeilen.

Behandel verbeterde foutencodesgeschikt en gebruik het actieveld om de noodzakelijke saneringsstappen te bepalen.

slechts een beperkt aantal verbeterde foutencodes rechtvaardigen een herpoging, terwijl de meesten alternatieve resoluties zoals gespecificeerd in het actieveld vereisen.

zorg ervoor dat om het even welk die heruitzettingsmechanisme voor het terugwinnen van vergunningsbesluiten wordt uitgevoerd niet in een eindeloze lijn resulteert en dat het pogingen tot een redelijk aantal beperkt (d.w.z., 2-3).

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

Vereisten

Risico's

Implementeer de API voor afmelden zodat gebruikers zich handmatig kunnen afmelden, hun geverifieerde profiel kunnen beëindigen en de voor elk verwijderd profiel opgegeven naam voor de REST API v2-handeling kunnen volgen:

• Voor MVPDs die een logout eindpunt steunen vereist de cliënttoepassing om aan verstrekte "url"in een gebruiker-agent te navigeren.
• Voor "appleSSO"typeprofielen, moet de cliënttoepassing de gebruiker begeleiden om zich ook uit het partnerniveau (het systeemmontages van Apple) te melden.

Risico dat de clienttoepassing niet goed functioneert als er ondersteuning aan de clienttoepassingszijde ontbreekt.

Vereisten

Risico's

Verzend de kopbal van de Vergunningvoor elk REST API v2 verzoek.

Risico's die HTTP 401 "Onbevoegde"foutenreacties teweegbrengen, systeemmiddelen overbelasten en latentie verhogen.

Verzend AP-apparaat-Herkenningstekenkopbal voor elk REST API v2 verzoek.

zelfs wanneer het verzoek uit een server namens een apparaat voortkomt, moet de AP-apparaat-Herkenner kopbalwaarde op het daadwerkelijke het stromen apparatenherkenningsteken wijzen.

Risico's die leiden tot HTTP 400 "Onjuiste Verzoek"foutenreacties, overladende systeemmiddelen en stijgende latentie.

Verzend x-apparaat-Infokopbal voor elk REST API v2 verzoek.

zelfs wanneer het verzoek uit een server namens een apparaat voortkomt, moet de x-Apparaat-Info kopbalwaarde op de daadwerkelijke het stromen apparateninformatie wijzen.

Risico's die worden ingedeeld als afkomstig van een onbekend platform en als onveilig worden behandeld, worden onderworpen aan meer beperkende regels, zoals kortere authentificatie-TTL's.

bovendien, zijn sommige gebieden, zoals het stromen apparaat connectionIp en connectionPort, verplicht voor eigenschappen zoals de Authentificatie van de Basis van het Spectrum.

Verwerk en sla een stabiel apparatenherkenningsteken op dat niet over updates of reboots voor AP-Apparaat-Herkenningstekenkopbal verandert.

voor platforms zonder een hardware herkenningsteken, produceer een uniek herkenningsteken van toepassingsattributen en handhaaf het.

Riseert authentificatieverlies wanneer het apparatenherkenningsteken verandert.

Zorg ervoor dat u alleen parameters en kopteksten verzendt die door REST API v2 worden verwacht.

Risico's die leiden tot HTTP 400 "Onjuiste Verzoek"foutenreacties, overladende systeemmiddelen en stijgende latentie.

Vereisten

Risico's

Behandel verbeterde foutencodesgeschikt en gebruik het actieveld om de noodzakelijke saneringsstappen te bepalen.

slechts een beperkt aantal verbeterde foutencodes rechtvaardigen een herpoging, terwijl de meesten alternatieve resoluties zoals gespecificeerd in het actieveld vereisen.

de meest verbeterde foutencodes die in worden vermeld Verbeterde Codes van de Fout - REST API V2documentatie kan volledig worden verhinderd als correct behandeld tijdens ontwikkelingsfase alvorens de toepassing te lanceren.

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

de mislukking van de cliënttoepassing van het risico toe te schrijven aan ontbrekende behandeling van de verbeterde foutencodes - veroorzakend onduidelijke foutenmeldingen, onjuiste gebruikershulp, of onjuist fallback gedrag.

Verschil tussen de afhandeling van HTTP-foutreacties (bijvoorbeeld 400, 401, 403, 404, 405, 500) en succesreacties (bijvoorbeeld 200, 201) die verbeterde foutcodes bevatten, zoals hierboven beschreven.

slechts een beperkt aantal de foutencodes van HTTP rechtvaardigen een herpoging, terwijl de meesten alternatieve resoluties vereisen.

De meeste de foutenreacties van HTTP kunnen volledig worden verhinderd als correct behandeld tijdens ontwikkelingsfase alvorens de toepassing te lanceren.

Risico's bij het overladen van systeembronnen, het verhogen van de latentie en het mogelijk activeren van de foutreacties van HTTP 429 "Te veel verzoeken".

de mislukking van de cliënttoepassing van het risico toe te schrijven aan ontbrekende behandeling van de verbeterde foutencodes - veroorzakend onduidelijke foutenmeldingen, onjuiste gebruikershulp, of onjuist fallback gedrag.

Vereisten

Risico's

Ontwikkel en test de toepassing gebruikend de officiële milieu's van de Authentificatie van Adobe Pass niet-productie:

• Prequal-production
• Geen staging

Voer grondige kwaliteitsborging (QA) in deze milieu's uit alvorens te lanceren aan productie.

de toepassingen van de Cliënt moeten niet aan versie-Productie zonder eerste volledige bevestiging van begin tot eind in niet productiemilieu's te werk gaan.

Risico's die ontstaan met kritieke en grote defecten.

het Ontbreken van een kort en efficiënt het zuiveren weg kan de Steun en de Techniek van Adobe van het snel ingrijpen verhinderen.

Handelingen

Risico's

Controleer proactief de geldigheid van het toegangstoken om het te verfrissen wanneer verlopen.

zorg ervoor dat om het even welk hertry mechanisme voor de behandeling van HTTP 401 "Onbevoegde"fouten eerst het toegangstoken alvorens het originele verzoek opnieuw te proberen verfrist.

Risico's die HTTP 401 "Onbevoegde"foutenreacties teweegbrengen, systeemmiddelen overbelasten en latentie verhogen.

Handelingen

Risico's

Sla de configuratierespons op in geheugen of permanente opslag gedurende een korte periode (bijvoorbeeld 3-5 minuten) om de prestaties te verbeteren en onnodige REST API v2-aanroepen tot een minimum te beperken.

Risico's bij het overladen van systeembronnen en het vergroten van de latentie.

Handelingen

Risico's

Bevestig authentificatiecode die door gebruikersinput op de secundaire (2de) toepassing (het scherm) wordt voorgelegd alvorens /api/v2/voor authentiek te verklaren API onder de volgende voorwaarden:

Authentificatie die binnen secundaire (scherm) toepassing met vooraf geselecteerde mvpd wordt uitgevoerd

• Maak gebruik van hervat authentificatiesessie- POST /api/v2/{serviceProvider}/zittingen/{code}

Authentificatie die binnen secundaire (scherm) toepassing zonder vooraf geselecteerde mvpd wordt uitgevoerd

• Maak gebruik van wint authentificatiesessieterug - GET /api/v2/{serviceProvider}/zittingen/{code}

De clienttoepassing ontvangt een fout als de opgegeven verificatiecode onjuist is getypt of als de verificatiesessie zou zijn verlopen.

Er zijn verschillende reacties op fouten en problemen met de werkstroom tijdens verificatie.

Zorg ervoor dat clienttoepassingen meerdere profielen kunnen verwerken door de gebruiker te vragen een profiel te selecteren of aangepaste logica toe te passen, zoals automatisch het profiel met de langste geldigheidsperiode selecteren.

Risico dat de clienttoepassing niet goed functioneert als er ondersteuning aan de clienttoepassingszijde ontbreekt.

Niet-basisstromen ondersteunen als de bedrijfsvoering van de clienttoepassing het volgende vereist:

• Verminderde toegangsstromen (premieeigenschap)
• Tijdelijke toegangsstromen (premiumfunctie)
• Single Sign-On toegangsstromen (standaardfunctie)

Risico's die tot een minder dan ideale gebruikerservaring leiden.

Handelingen

Risico's

Toon duidelijke gebruiker terugkoppelt als een pre-vergunningsbesluit wordt ontkend, gebruikend overseinen die door MVPDs of Adobe via verbeterde foutencodes worden verstrekt.

Risico's die tot een minder dan ideale gebruikerservaring leiden.

Handelingen

Risico's

Valideer media tokens gebruikend de bibliotheek van de Verificateur van het Symbolische van 0} Media.

Risico's van frauduleuze regelingen zoals stroom ripping.

Toon duidelijke gebruiker terugkoppelt als een vergunningsbesluit wordt ontkend, gebruikend overseinen die door MVPDs of Adobe via verbeterde foutencodes worden verstrekt.

Risico's die tot een minder dan ideale gebruikerservaring leiden.

Handelingen

Risico's

Vermijd automatisch (programmatically) het roepen van logout API in scenario's zoals ontkende preauthentication of vergunning, aangezien logout API slechts in antwoord op een direct gebruikersverzoek zou moeten worden aangehaald.

Risico's verwarrend de gebruiker dat de authentificatie ontbreekt.

Handelingen

Risico's

U kunt de code van REST API v1 opnieuw gebruiken voor het berekenen van de apparaat-id en apparaatinformatie met kleine aanpassingen, maar zorg ervoor dat u alleen voor REST API v2 verwachte parameters en headers verzendt.

hergebruik code van REST API v1 voor het roepen van DCR API om een toegangstoken terug te winnen.

-

Handelingen

Risico's

Verzeker de volgende basisstromen over apparaten en platforms worden getest:

de stromen van de Authentificatie

• Verificatiescenario primaire toepassing (scherm)
• Secundair verificatiescenario voor toepassing (scherm)

(Optioneel) Voorbereidende stromen

• Beslissingsscenario voor testvergunningen
• Besluiten testen

de stromen van de Vergunning

• Beslissingsscenario voor testvergunningen
• Besluiten testen

Logout stromen

extra, test andere toegangsstromen, indien van toepassing:

• Verminderde toegangsstromen (premieeigenschap)
• Tijdelijke toegangsstromen (premiumfunctie)
• Single Sign-On toegangsstromen (standaardfunctie)

Omvat de top-MVPD-integratie (die de meest gebruikte leveranciers omvat).

Risico's van onvoorziene mislukkingen in productie, vooral over minder vaak geteste platforms of zeldzame stromen als negatieve scenario's.

Gebruik de Adobe Developerwebsite.

-

Fase

Verplicht

(Sterk) Aanbevolen

De toegangstokens van de de cliëntgeloofsbrieven van het geheime voorgeheugen

Toegangstokens valideren en vernieuwen

Ophalen van configuratiereacties minimaliseren

Respons cacheconfiguratie

Het opiniepeilingsmechanisme bepaalt het stemmen

Geheime voorgeheugen delen van profielen

De steun veelvoudige profielen {de Eigenschap van de Verslechtering van de Steun (als bedrijfsvereiste)

de Eigenschap van de Steun TempPass (als bedrijfsvereiste)

Steun Enige Sign-On Eigenschap (als bedrijfsvereiste)

De vergunningsbesluiten van het geheime voorgeheugen {

proberen mechanisme fijn het stemmen

De gebruikerservaring verbeteren door foutcodes te gebruiken voor beslissingen waarbij voorafgaande toestemming is geweigerd

Wint vergunningsbesluit terug wanneer de gebruiker om playback

verzoekt wil mechanisme fijnstemmen

Verbeter gebruikerservaring gebruikend foutencodes voor ontkende toestemmingsbesluiten

het symbolische bevestiging van Media

Implementeer de aanmeldings-API zodat gebruikers zich handmatig kunnen afmelden

De aanmeldings-API niet automatisch aanroepen

Verplicht

(Sterk) Aanbevolen

Verplichte headerspecificaties volgen

Code van REST API v1 opnieuw gebruiken

Implementeer verbeterde fout behandeling

voert de fout van HTTP behandeling uit

-