API-referens för JavaScript SDK javascript-sdk-api-reference
API-referens api-reference
Dessa funktioner initierar förfrågningar om interaktion med ett MVPD. Alla anrop är asynkrona. Du måste implementera callback för att kunna hantera svaren:
setRequestor (inRequestorID, endpoints, options) setrequestor(inRequestorID,endpoints,options)
Beskrivning: Identifierar webbplatsen som förfrågningarna kommer från. Du måste ringa detta anrop innan du kan göra andra API-anrop i en kommunikationssession.
Parametrar:
-
inRequestorID - Den unika identifierare som Adobe tilldelade den ursprungliga platsen under registreringen.
-
slutpunkter - Den här parametern är valfri. Det kan vara något av följande värden:
- En array som gör att du kan ange slutpunkter för autentisering och auktoriseringstjänster som tillhandahålls av Adobe (olika instanser kan användas i felsökningssyfte). Om flera URL:er anges består MVPD-listan av slutpunkterna från alla tjänsteleverantörer. Varje MVPD är kopplat till den snabbaste tjänsteleverantören, dvs. den leverantör som svarade först och som stöder det MVPD. Som standard (om inget värde anges) används Adobes tjänstleverantör (http://sp.auth.adobe.com/).
Exempel:
setRequestor("IFC", ["http://sp.auth-dev.adobe.com/adobe-services"])
-
options - Ett JSON-objekt som innehåller värdet för program-ID, uppdateringslösa inställningar för besökar-ID (inloggning i bakgrunden) och MVPD-inställningar (iFrame). Alla värden är valfria.
- Om detta anges rapporteras Experience Cloud visitorID för alla nätverksanrop som utförs av biblioteket. Värdet kan användas senare för avancerade analysrapporter.
- Om den unika identifieraren för programmet anges -
applicationId
- läggs värdet till i alla efterföljande anrop som görs av programmet som en del av HTTP-huvudet X-Device-Info. Det här värdet kan senare hämtas från ESM-rapporter med rätt fråga.
Obs! Alla JSON-tangenter är skiftlägeskänsliga.
Exempel:
setRequestor("IFC", {
"visitorID": "THE_ECID_VALUE",
"applicationId": "APP_ID_VALUE"
})
- Programmeraren kan åsidosätta de MVPD-inställningar som har konfigurerats i Adobe Pass Authentication genom att ange om en iFrame krävs eller inte för inloggning (iFrameRequired -tangenten) och iFrame-dimensionerna (iFrameWidth och iFrameHeight -tangenterna). JSON-objektet har följande mall:
{
"visitorID": <string>,
"backgroundLogin": <boolean>,
"backgroundLogout": <boolean>,
"mvpdConfig":{
"MVPD_ID_1":{
"iFrameRequired": <boolean>,
"iFrameWidth": <integer>,
"iFrameHeight": <integer>
},
...
"MVPD_ID_N":{
"iFrameRequired": <boolean>,
"iFrameWidth": <integer>,
"iFrameHeight": <integer>
}
}
}
Alla toppnivånycklar i mallen ovan är valfria och har standardvärden (backgroundLogin, backgroundLogut är som standard false och mvpdConfig är null, vilket innebär att inga MVPD-inställningar åsidosätts).
- Obs! Om du anger ogiltiga värden/typer för parametrarna ovan resulterar det i ett odefinierat beteende.
Här är ett exempel på konfiguration för följande scenario: aktivera uppdatering utan inloggning och inloggning, ändra MVPD1 till fullständig sidomdirigering (ej iFrame) och MVPD2 till iFrame-inloggning med width=500 och height=300:
{
"backgroundLogin": true,
"backgroundLogout": true,
"mvpdConfig":{
"MVPD1":{
"iFrameRequired": false
},
"MVPD2":{
"iFrameRequired": true,
"iFrameWidth": 500,
"iFrameHeight": 300
}
}
}
Återanrop har utlösts: setConfig()
getAuthorization(inResourceID, redirect_url) getauthorization(inresourceid,redirect_url)
Beskrivning: Begär auktorisering för den angivna resursen. Varje gång en kund försöker få åtkomst till en auktoriserbar resurs anropar du den här funktionen för att få en kort åtkomsttoken från Access Enabler. Resurs-ID:n avtalas med det sidodokument som tillhandahåller auktorisering.
Använder den cachelagrade autentiseringstoken för den aktuella kunden. Om ingen sådan token hittas initierar autentiseringsprocessen först och fortsätter sedan med auktoriseringen.
Parametrar:
inResourceID
- ID:t för resursen som användaren begär auktorisering för.redirect_url
- Ange en omdirigerings-URL om du vill, så att MVPD:s auktoriseringsprocess återgår till den sidan i stället för den sida som auktoriseringen initierades från.
Återanrop har utlösts: setToken() vid lyckad, tokenRequestFailed vid fel
getAuthentication(redirect_url) getauthentication(redirect_url
Beskrivning: Begär autentisering för den aktuella kunden. Anropas vanligtvis som svar på en klickning på en inloggningsknapp. Söker efter en cachelagrad autentiseringstoken för den aktuella kunden. Om ingen sådan token hittas initierar autentiseringsprocessen. Detta anropar standarddialogrutan eller den anpassade dialogrutan för val av leverantör och använder sedan den valda providern för att dirigera om till inloggningsgränssnittet för MVPD.
När det är klart skapar och sparar en autentiseringstoken för användaren. Om autentiseringen misslyckas returnerar providern ett felmeddelande till ditt setAuthenticationStatus() -återanrop.
Parametrar:
- redirect_url - Ange en omdirigerings-URL om du vill, så att MVPD:s autentiseringsprocess returnerar användaren till den sidan i stället för till den sida som autentiseringen initierades från.
Återanrop har utlösts: setAuthenticationStatus(), displayProviderDialog(), sendTrackingData()
checkAuthN checkauthn
Beskrivning: Kontrollerar den aktuella kundens autentiseringsstatus. Inte associerat med något användargränssnitt.
Återanrop har utlösts: setAuthenticationStatus()
checkAuthorization(inResourceID) checkauthorization(inresourceid)
Beskrivning: Den här metoden används av programmet för att kontrollera auktoriseringsstatusen för den aktuella kunden och den angivna resursen. Det börjar med att kontrollera autentiseringsstatusen först. Om den inte autentiseras aktiveras callback-funktionen tokenRequestFailed() och metoden avslutas. Om användaren är autentiserad utlöses även auktoriseringsflödet. Se information om metoden getAuthorization().
Parametrar:
inResourceID
- ID:t för resursen som användaren begär auktorisering för.
Återanrop har utlösts:
setToken(), tokenRequestFailed(), sendTrackingData(), setAuthenticationStatus()
checkPreauthorizedResources(resources) checkPreauthorizedResources(resources)
Beskrivning: Begär preflight-auktoriseringsstatus för en lista med
resurser.
Parametrar:
- resources: Resursparametern är en array med resurser som auktoriseringen ska kontrolleras för. Varje element i listan ska vara en sträng som representerar resurs-ID:t. Resurs-ID:t har samma begränsningar som resurs-ID:t i anropet
getAuthorization()
, det vill säga det är ett avtalat värde mellan Programmer och MVPD, eller ett medie-RSS-fragment.
checkPreauthorizedResources(resources-cache=true) checkPreauthorizedResources(resources-cache=true)
Denna API-variant är tillgänglig från och med JS SDK version 4.0
Parametrar:
-
resources: Resursparametern är en array med resurser som auktoriseringen ska kontrolleras för. Varje element i listan ska vara en sträng som representerar resurs-ID:t. Resurs-ID:t har samma begränsningar som resurs-ID:t i anropet
getAuthorization()
, det vill säga det är ett avtalat värde mellan Programmer och MVPD, eller ett medie-RSS-fragment. -
cache: Om det interna cacheminnet ska användas vid sökning efter förauktoriserade resurser. Det här är en valfri parameter som har standardvärdet true. Om värdet är true är beteendet identiskt med ovanstående API, vilket innebär att efterföljande anrop till den här funktionen kommer att använda ett internt cache-minne för att lösa en förauktoriserad resurs. Om false skickas för den här parametern inaktiveras det interna cacheminnet, vilket resulterar i ett serveranrop varje gång API:t checkPreauthorizedResources anropas.
Återanrop har utlösts: preauthorizedResources()
getMetadata(Key) getMetadata
Beskrivning: Hämtar information som visas som metadata av biblioteket för Access Enabler.
Det finns två typer av metadata:
- Statisk (TTL för autentiseringstoken, TTL för auktoriseringstoken och enhets-ID)
- Användarmetadata (Detta inkluderar användarspecifik information som skickas från MVPD till användarens enhet under autentiserings- och/eller auktoriseringsflödena)
Mer information: Användarmetadata
Parametrar:
-
nyckel: Ett ID som anger begärda metadata:
-
Om nyckeln är
"TTL_AUTHN",
görs frågan för att hämta förfallotiden för autentiseringstoken. -
Om nyckeln är
"TTL_AUTHZ"
och parametrarna är en array som innehåller resurs-ID:t som en sträng, görs frågan för att hämta förfallotiden för den auktoriseringstoken som är associerad med den angivna resursen. -
Om nyckeln är
"DEVICEID"
ställs frågan för att hämta aktuellt enhets-ID. Observera att den här funktionen är inaktiverad som standard och programmerare bör kontakta Adobe för att få information om aktivering och avgifter. -
Om nyckeln kommer från följande lista över användarmetadatatyper, skickas ett JSON-objekt som innehåller motsvarande användarmetadata till callback-funktionen
setMetadataStatus()
: -
"zip"
- Postnummer -
"encryptedZip"
- Krypterat postnummer -
"householdID"
- Hushållsidentifierare. Om ett MVPD inte stöder underkonton är detta identiskt med userID. -
"maxRating"
- Högsta föräldraklassificering för användaren -
"userID"
- användaridentifieraren. Om ett MVPD-dokument har stöd för underkonton och användaren inte är huvudkontot, kommer userID att vara ett annat än houseID. -
"channelID"
- En lista över kanaler som användaren har rätt att visa -
"is_hoh"
- Flagga som identifierar om en användare är chef för hushållet -
"encryptedZip"
- krypterat postnummer -
"typeID"
- Flagga som identifierar om användarkontot är ett primärt/sekundärt konto -
"primaryOID"
- Hushållsidentifierare -
"postalCode"
- Liknar postnummer -
"acctID"
- konto-ID -
"acctParentID"
- överordnat konto-ID
Obs! De faktiska användarmetadata som är tillgängliga för en programmerare beror på vad ett MVPD-program gör tillgängligt. I Användarmetadata finns en aktuell lista över tillgängliga användarmetadata.
-
Exempel:
// Assume that a reference to the AccessEnabler has been previously
// obtained and stored in the "ae" variable
ae.setRequestor("SITE");
ae.checkAuthentication();
function setAuthenticationStatus(status, reason) {
if (status == 1) {
//user is authenticated, request metadata
ae.getMetadata("zip");
ae.getMetadata("maxRating");
} else {
...
}
}
Återanrop har utlösts: setMetadataStatus()
setSelectedProvider(providerid) setSelectedProvider
Beskrivning: Anropa den här funktionen när användaren har valt ett MVPD-program i användargränssnittet för val av leverantör för att skicka providervalet till åtkomstaktiveringen eller anropa den här funktionen med en null-parameter om användaren har stängt användargränssnittet för val av leverantör utan att välja någon leverantör.
Återanrop
utlöses: setAuthationStatus(), sendTrackingData()
getSelectedProvider() getSelectedProvider
Beskrivning: Hämtar resultatet av kundens val i dialogrutan för val av leverantör. Detta kan användas när som helst efter den inledande autentiseringskontrollen.
Den här funktionen är asynkron och returnerar resultatet till callback-funktionen selectedProvider()
.
- MVPD Det aktuella MVPD-värdet eller null om inget MVPD-värde har valts.
- AE_State Resultatet av autentiseringen för den aktuella kunden är Ny användare, Användare ej autentiserad eller Användare autentiserad
Återanrop har utlösts: selectedProvider()
utloggning logout
Beskrivning: Loggar ut den aktuella kunden och rensar all autentiserings- och auktoriseringsinformation för den användaren. Tar bort alla authN- och authZ-tokens från kundens system.
Återanrop har utlösts: setAuthenticationStatus()
Återanropsdefinition calllback-definitions
Du måste implementera dessa återanrop för att kunna hantera svaren på dina asynkrona förfrågningsanrop:
entitlementLoaded() entitlementLoaded
Beskrivning: Utlöses när åtkomstaktiveraren har slutfört initieringen och är redo att ta emot begäranden. Implementera den här återanropet för att veta när du kan starta kommunikationen med API:t för åtkomstaktivering.
setConfig(configXML) setconfig(configXML)
Beskrivning: Implementera det här återanropet för att ta emot konfigurationsinformationen och MVPD-listan.
Parametrar:
- configXML: xml-objekt som innehåller konfigurationen för den aktuella REQUESTOR inklusive MVPD-listan.
Utlöses av: setRequestor()
displayProviderDialog(providers) displayproviderdialog(providers)
Beskrivning: Implementera det här återanropet för att anropa ditt eget anpassade användargränssnitt för val av leverantör. Dialogrutan ska ha visningsnamnet (och den valfria logotypen) för att ge kunderna möjlighet att välja. När kunden har gjort ett val och stängt dialogrutan skickar du det associerade ID:t för den valda providern i anropet till setSelectedProvider().
Parametrar:
- providers - en array med objekt som representerar begärda MVPD-filer:
var mvpd = {
ID: "someprov",
displayName: "Some Provider",
logoURL: "http://www.someprov.com/images/logo.jpg"
}
Utlöses av: getAuthentication(), getAuthorization()
createIFrame(inWidth, inHeight) createIFrame(inWidth,inHeight)
Beskrivning: Implementera det här återanropet om användaren har valt ett MVPD som kräver en iFrame där användargränssnittet för inloggningssidan för autentisering ska visas.
Utlöses av: setSelectedProvider()
setAuthenticationStatus(isAuthenticated, errorCode) set-authn-status-isauthn-error
Beskrivning: Implementera det här återanropet för att ta emot autentiseringsstatusen (1=autentiserad eller 0=inte autentiserad) och ett beskrivande felmeddelande om något fel uppstod vid försök att fastställa autentiseringsstatusen (tom sträng när kontrollen har slutförts).
Parametrar:
- isAuthenticated - Tillhandahåller autentiseringsstatus: 1 (autentiserad) eller 0 (inte autentiserad).
- errorCode - Alla fel som uppstod när autentiseringsstatusen fastställdes. En tom sträng om ingen.
Utlöses av: checkAuthentication(), getAuthentication(), checkAuthorization()
sendTrackingData(trackingEventType, trackingData) sendTrackingData(trackingEventType,trackingData)
Beskrivning: Implementera det här återanropet för att ta emot spårningsdata när specifika händelser inträffar. Du kan till exempel använda detta för att hålla reda på hur många användare som har loggat in med samma inloggningsuppgifter. Spårning kan för närvarande inte konfigureras. Med Adobe Pass Authentication 1.6 rapporterar sendTrackingData()
även information om enheten, klienten för åtkomstaktivering och operativsystemstypen. Återanropet sendTrackingData()
är fortfarande bakåtkompatibelt.
-
Möjliga värden för enhetstypen:
- dator
- surfplatta
- mobil
- gameconsole
- okänd
-
Möjliga värden för klienttypen Åtkomstaktivering:
- html5
- ios
- android
Skickar händelsetypen och en array med associerad information. Händelsetyper är:
Utlöses av: checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization()
setToken(inRequestedResourceID, inToken) setToken(inRequestedResourceID,inToken)
Beskrivning: Implementera det här återanropet för att ta emot den kortlivade medietoken (inToken) och ID:t för resursen (inRequestedResourceID) som en auktoriseringsbegäran eller en kontrollauktoriseringsbegäran har gjorts för och slutförts.
Utlöses av: checkAuthorization(), getAuthorization()
tokenRequestFailed(inRequestedResourceID, inRequestErrorCode, inRequestDetailedErrorMessage) token-request-failed-error-msg
Beskrivning: Implementera det här återanropet som ska signaleras när en auktorisering eller en begäran om kontrollauktorisering har misslyckats. Kan även användas av en MVPD för att ge ett anpassat meddelande som ska visas av programmeraren.
Parametrar:
- inRequestedResourceID - en sträng som anger det resurs-ID som användes i auktoriseringsbegäran.
- inRequestErrorCode - En sträng som visar felkoden för Adobe Pass-autentiseringen och anger orsaken till felet. Möjliga värden är "User Not Authenticated Error" och "User Not Authorized Error". Mer information finns i "Callback error codes" nedan.
- inRequestDetailedErrorMessage - En extra beskrivande sträng som är lämplig för visning. Om den här beskrivande strängen inte är tillgänglig av någon anledning skickar Adobe Pass Authentication en tom sträng (""). Detta kan användas av en MVPD för att skicka anpassade felmeddelanden eller försäljningsrelaterade meddelanden. Om en prenumerant nekas auktorisering för en resurs kan MVPD svara med en
*inRequestDetailedErrorMessage*
som: . Du har för närvarande inte åtkomst till den här kanalen i paketet. Om du vill uppgradera ditt paket klickar du *här*." Meddelandet skickas av Adobe Pass Authentication via det här återanropet till programmerarens webbplats. Programmeraren kan sedan välja att visa eller ignorera den. Adobe Pass-autentisering kan också använda*inRequestDetailedErrorMessage*
för att meddela programmeraren om det tillstånd som kan ha orsakat ett fel. "Ett nätverksfel uppstod t.ex. vid kommunikation med providerns auktoriseringstjänst".
Utlöses av: checkAuthorization(), getAuthorization()
preauthorizedResources(authorizedResources) preauthorizedResources(authorizedResources)
Beskrivning: Återanrop utlöses av åtkomstaktiveraren som levererar listan över auktoriserade resurser som returneras efter ett anrop till checkPreauthorizedResources()
.
Parametrar:
- authorizedResources: Listan över auktoriserade resurser.
Utlöses av: checkPreauthorizedResources()
setMetadataStatus(nyckel, krypterad, data) setMetadataStatus(key,encrypted,data)
Beskrivning: Återanrop som utlöses av Access Enabler som levererar de metadata som efterfrågas via ett getMetadata()
-anrop.
Mer information: Användarmetadata
Parametrar:
- key (String): Nyckeln till de metadata som förfrågan gjordes för.
- encrypted (Boolean): En flagga som anger om värdet är krypterat eller inte. Om värdet är "true" är "value" en JSON Web Encrypted-representation av det faktiska värdet.
- data (JSON-objekt): Ett JSON-objekt med representation av metadata. För enkla begäranden (
TTL_AUTHN
,TTL_AUTHZ
,DEVICEID
) är resultatet en sträng (som representerar autentiserings-TTL, auktoriserings-TTL eller enhets-ID). Om det gäller en begäran om användarmetadata kan resultatet vara ett primitivt eller JSON-objekt som representerar metadatanyttolasten. Den faktiska strukturen för JSON-användarmetadataobjekt liknar följande:
{
updated: 1334243471,
encrypted: ["encryptedProp"],
data: {
zip: ["12345", "34567"],
maxrating: {
"MPAA": "PG-13",
"VCHIP": "TV-Y",
"URL": "http://exam.pl/e/manage/ratings"
},
householdid: "3456",
uid: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=",
channelID: ["channel-1", "channel-2"]
}
Exempel:
// Implement the setMetadataStatus() callback
function setMetadataStatus(key, encrypted, data) {
if (encrypted) {
//the metadata value is encrypted
//needs to be decrypted by the programmer
data = decrypt(data);
}
alert(key + "=" + data);
}
Utlöses av: getMetadata()
Till början
selectedProvider(result) selectedProvider(result)
Beskrivning: Implementera det här återanropet för att ta emot det aktuella MVPD-värdet och resultatet av autentiseringen av den aktuella användaren som har kapslats in i parametern result
. Parametern result
är ett objekt med följande egenskaper:
- MVPD Det aktuella MVPD-värdet eller null om inget MVPD-värde har valts.
- AE_State Resultat av autentisering för den aktuella användaren, en av Ny användare, Användare ej autentiserad eller Användare autentiserad
Utlöses av: getSelectedProvider()