DokumentationAdobe PassAdobe Pass-Authentifizierung

JavaScript-SDK-API-Referenz javascript-sdk-api-reference

Last update: Wed Sep 27 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
Der Inhalt dieser Seite dient nur Informationszwecken. Für die Verwendung dieser API ist eine aktuelle Lizenz von Adobe erforderlich. Eine unbefugte Anwendung ist nicht zulässig.

API-Referenz api-reference

Diese Funktionen lösen Interaktionsanfragen mit einem MVPD aus. Alle Aufrufe sind asynchron. Sie müssen Callbacks um die Antworten zu verarbeiten:

setRequestor (inRequestorID, endpoints, options) setrequestor(inRequestorID,endpoints,options)

Beschreibung: Identifiziert die Site, von der die Anforderungen stammen. Sie müssen diesen Aufruf vor allen anderen API-Aufrufen in einer Kommunikationssitzung durchführen.

Parameter:

  • inRequestorID - Die eindeutige Kennung, die Adobe während der Registrierung der ursprünglichen Site zugewiesen hat.

  • Endpunkte - Dieser Parameter ist optional. Es kann sich um einen der folgenden Werte handeln:

    • Ein Array, mit dem Sie Endpunkte für von Adobe bereitgestellte Authentifizierungs- und Autorisierungsdienste angeben können (verschiedene Instanzen können zum Debugging verwendet werden). Wenn mehrere URLs bereitgestellt werden, setzt sich die MVPD-Liste aus den Endpunkten aller Service Provider zusammen. Jeder MVPD ist mit dem schnellsten Dienstleister verbunden, d. h. dem Provider, der zuerst reagiert hat und dieser MVPD unterstützt. Standardmäßig (wenn kein Wert angegeben ist) wird der Adobe-Dienstleister verwendet (http://sp.auth.adobe.com/).

    Beispiel:

    • setRequestor("IFC", ["http://sp.auth-dev.adobe.com/adobe-services"])

  • options - Ein JSON-Objekt, das den Wert für die Anwendungs-ID, den Wert für "refresh-less"(Einstellungen für die Hintergrundanmeldung bei Abmeldung) und die MVPD-Einstellungen (iFrame) enthält. Alle Werte sind optional.

    1. Wenn angegeben, wird die Experience Cloud-visitorID bei allen von der Bibliothek durchgeführten Netzwerkaufrufen gemeldet. Der Wert kann später für erweiterte Analyseberichte verwendet werden.
    2. Wenn die eindeutige Kennung der Anwendung angegeben ist -applicationId - Der Wert wird zu allen nachfolgenden Aufrufen hinzugefügt, die von der Anwendung als Teil des HTTP-Headers X-Device-Info durchgeführt werden. Dieser Wert kann später aus abgerufen werden. ESM Berichte mithilfe der entsprechenden Abfrage erstellen.

    Hinweis: Bei allen JSON-Schlüsseln wird zwischen Groß- und Kleinschreibung unterschieden.

    Beispiel:

   setRequestor("IFC", {
      "visitorID": "THE_ECID_VALUE",
      "applicationId": "APP_ID_VALUE"
  })
  • Der Programmierer kann die in der Adobe Pass-Authentifizierung konfigurierten MVPD-Einstellungen überschreiben, indem er angibt, ob ein iFrame erforderlich ist oder nicht für die Anmeldung (iFrameRequired Schlüssel) und die iFrame-Dimensionen (iFrameWidth und iFrameHeight Schlüssel). Das JSON-Objekt weist die folgende Vorlage auf:
    {
       "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>
          }
       }
    }

Alle Schlüssel der obersten Ebene in der obigen Vorlage sind optional und weisen Standardwerte auf (backgroundLogin, backgroundLogut sind standardmäßig false und mvpdConfig ist null - d. h., dass keine MVPD-Einstellungen überschrieben werden).

  • Hinweis: Wenn Sie ungültige Werte/Typen für die obigen Parameter angeben, führt dies zu einem undefinierten Verhalten.

Hier finden Sie eine Beispielkonfiguration für das folgende Szenario: Aktivieren der Anmeldung ohne Aktualisierung und Abmeldung, Ändern von MVPD1 zu einer vollständigen Seitenumleitungsanmeldung (Nicht-iFrame) und MVPD2 zu iFrame-Anmeldung mit Breite=500 und Höhe=300:

    {
       "backgroundLogin": true,
       "backgroundLogout": true,
       "mvpdConfig":{
          "MVPD1":{
             "iFrameRequired": false
          },
          "MVPD2":{
             "iFrameRequired": true,
             "iFrameWidth": 500,
             "iFrameHeight": 300
          }
       }
    }

Ausgelöste Rückrufe: setConfig()

Zurück zum Anfang

getAuthorization(inResourceID, redirect_url) getauthorization(inresourceid,redirect_url)

Beschreibung: Fordert die Autorisierung für die angegebene Ressource an. Jedes Mal, wenn ein Kunde versucht, auf eine autorisierbare Ressource zuzugreifen, rufen Sie diese Funktion auf, um ein kurzlebiges Autorisierungstoken vom Access Enabler zu erhalten. Ressourcen-IDs werden mit dem MVPD vereinbart, der die Autorisierung erteilt.

Verwendet das zwischengespeicherte Authentifizierungstoken für den aktuellen Kunden. Wenn kein solches Token gefunden wird, initiiert zunächst den Authentifizierungsprozess und fährt dann mit der Autorisierung fort.

Parameter:

  • inResourceID - Die Kennung der Ressource, für die der Benutzer eine Autorisierung anfordert.
  • redirect_url - Optional können Sie eine Umleitungs-URL angeben, sodass der Autorisierungsprozess des MVPD den Benutzer auf diese Seite und nicht auf die Seite zurückgibt, von der aus die Autorisierung initiiert wurde.

Ausgelöste Rückrufe: setToken() zum Erfolg, tokenRequestFailed bei Fehlern

CAUTION
Verwenden Sie nach Möglichkeit checkAuthorization() anstelle von getAuthorization() . Die Methode getAuthorization() startet einen vollständigen Authentifizierungsfluss (wenn der Benutzer nicht authentifiziert ist), was zu einer komplizierten Implementierung auf der Seite des Programmierers führen kann.

Zurück zum Anfang

getAuthentication(redirect_url) getauthentication(redirect_url

Beschreibung: Fordert Authentifizierung für den aktuellen Kunden an. Wird normalerweise als Reaktion auf einen Klick auf eine Anmelde-Schaltfläche aufgerufen. Sucht nach einem im Cache gespeicherten Authentifizierungstoken für den aktuellen Kunden. Wenn kein solches Token gefunden wird, initiiert den Authentifizierungsprozess. Dadurch wird das standardmäßige oder benutzerdefinierte Dialogfeld zur Anbieterauswahl aufgerufen und der ausgewählte Provider wird dann zur Anmeldungsschnittstelle des MVPD weitergeleitet.

Bei Erfolg erstellt und speichert ein Authentifizierungstoken für den Benutzer. Wenn die Authentifizierung fehlschlägt, gibt der Provider eine entsprechende Fehlermeldung an Ihre setAuthenticationStatus() Callback.

Parameter:

  • redirect_url - Geben Sie optional eine Umleitungs-URL an, sodass der Authentifizierungsprozess des MVPD den Benutzer auf diese Seite und nicht auf die Seite zurückgibt, von der aus die Authentifizierung initiiert wurde.

Ausgelöste Rückrufe: setAuthenticationStatus(), displayProviderDialog(), sendTrackingData()

Zurück zum Anfang

checkAuthN checkauthn

Beschreibung: Überprüft den aktuellen Authentifizierungsstatus für den aktuellen Kunden. Kein UI zugeordnet.

Ausgelöste Rückrufe: setAuthentcationStatus()

Zurück zum Anfang

checkAuthorization(inResourceID) checkauthorization(inresourceid)

Beschreibung: Diese Methode wird von der Anwendung verwendet, um den Autorisierungsstatus für den aktuellen Kunden und die angegebene Ressource zu überprüfen. Zunächst wird der Authentifizierungsstatus überprüft. Wenn sie nicht authentifiziert ist, wird der Rückruf tokenRequestFailed() ausgelöst und die Methode wird beendet. Wenn der Benutzer authentifiziert ist, wird auch der Autorisierungsfluss Trigger. Siehe Details zu den [getAuthorization()] (#getAuthZ -Methode.

TIP
Verwenden der Funktionen "Check-Status" Sie müssen weder den Status der Authentifizierung noch der Autorisierung überprüfen, bevor Sie eine Autorisierung anfordern. Sie können diese Funktionen aufrufen, um beispielsweise Ihre eigene Statusanzeige zu aktualisieren. Verwenden Sie sie nicht, wenn Sie eine Benutzerinteraktion benötigen.

Parameter:

  • inResourceID - Die Kennung der Ressource, für die der Benutzer eine Autorisierung anfordert.

Ausgelöste Rückrufe:
setToken(), tokenRequestFailed(), sendTrackingData(), setAuthenticationStatus()

checkPreauthorizedResources(resources) checkPreauthorizedResources(resources)

Beschreibung: Fordert den Genehmigungsstatus "Preflight"für eine Liste von Ressourcen an.

Parameter:

  • resources: Der Ressourcenparameter ist ein Array von Ressourcen, für die die Autorisierung überprüft werden soll. Jedes Element in der Liste sollte eine Zeichenfolge sein, die die Ressourcen-ID darstellt. Die Ressourcen-ID unterliegt den gleichen Einschränkungen wie die Ressourcen-ID in der getAuthorization() -Aufruf, d. h. es handelt sich um einen zwischen dem Programmierer und dem MVPD oder einem Medien-RSS-Fragment vereinbarten Wert.

checkPreauthorizedResources(resources-cache=true) checkPreauthorizedResources(resources-cache=true)

Diese API-Variante ist ab JS SDK-Version 4.0 verfügbar.

Parameter:

  • resources: Der Ressourcenparameter ist ein Array von Ressourcen, für die die Autorisierung überprüft werden soll. Jedes Element in der Liste sollte eine Zeichenfolge sein, die die Ressourcen-ID darstellt. Die Ressourcen-ID unterliegt den gleichen Einschränkungen wie die Ressourcen-ID in der getAuthorization() -Aufruf, d. h. es handelt sich um einen zwischen dem Programmierer und dem MVPD oder einem Medien-RSS-Fragment vereinbarten Wert.

  • cache: Ob der interne Cache bei der Suche nach vorautorisierten Ressourcen verwendet werden soll. Dies ist ein optionaler Parameter, standardmäßig true. Wenn "true", ist das Verhalten mit der oben genannten API identisch, d. h. nachfolgende Aufrufe dieser Funktion verwenden einen internen Cache, um eine vorab autorisierte Ressource aufzulösen. Übergeben false für diesen Parameter deaktiviert den internen Cache, was zu einem Server-Aufruf bei jedem checkPreauthorizedResources API wird aufgerufen.

Ausgelöste Rückrufe: preauthorizedResources()

Zurück zum Anfang

getMetadata(Key) getMetadata

Beschreibung: Ruft Informationen ab, die von der Access Enabler-Bibliothek als Metadaten bereitgestellt werden.

Es gibt zwei Arten von Metadaten:

  • Statisch (TTL des Authentifizierungstokens, TTL des Autorisierungstokens und Geräte-ID)
  • Benutzermetadaten (Dies umfasst benutzerspezifische Informationen, die vom MVPD an das Gerät des Benutzers während der Authentifizierungs- und/oder Autorisierungsflüsse weitergegeben werden.)

Weitere Informationen: Benutzermetadaten

Parameter:

  • key: Eine ID, die die angeforderten Metadaten angibt:

    • Wenn der Schlüssel "TTL_AUTHN", dann wird die Abfrage durchgeführt, um die Ablaufzeit des Authentifizierungstokens abzurufen.

    • Wenn der Schlüssel "TTL_AUTHZ" und params ist ein Array, das die Ressourcen-ID als Zeichenfolge enthält. Anschließend wird die Abfrage durchgeführt, um die Ablaufzeit des Autorisierungstokens zu erhalten, das mit der angegebenen Ressource verknüpft ist.

    • Wenn der Schlüssel "DEVICEID" dann erfolgt die Abfrage, um die aktuelle Geräte-ID abzurufen. Beachten Sie, dass diese Funktion standardmäßig deaktiviert ist und Programmierer sich an Adobe wenden sollten, um Informationen über Aktivierung und Gebühren zu erhalten.

    • Wenn der Schlüssel aus der folgenden Liste von Benutzer-Metadatentypen stammt, wird ein JSON-Objekt mit den entsprechenden Benutzermetadaten an die setMetadataStatus() Callback-Funktion:

    • "zip" - Postleitzahl

    • "encryptedZip" - Verschlüsselte Postleitzahl

    • "householdID" - Haushaltskennung. Wenn ein MVPD keine Unterkonten unterstützt, ist dies mit der userID identisch.

    • "maxRating" - Maximale elterliche Bewertung für den Benutzer

    • "userID" - Die Benutzer-ID. Wenn ein MVPD Unterkonten unterstützt und der Benutzer nicht das Hauptkonto ist, unterscheidet sich die Benutzer-ID von der Haushalts-ID.

    • "channelID" - Die Liste der Kanäle, die der Benutzer anzeigen darf

    • "is_hoh" - Flag, das angibt, ob ein Benutzer Haushaltsleiter ist

    • "encryptedZip" - Verschlüsselte Postleitzahl

    • "typeID" - Flag, das angibt, ob das Benutzerkonto ein primäres/sekundäres Konto ist

    • "primaryOID" - Haushaltskennung

    • "postalCode" - Ähnlich wie Postleitzahl

    • "acctID" - Konto-ID

    • "acctParentID" - Übergeordnete Kontokennung

    Hinweis: Die tatsächlichen Benutzermetadaten, die einem Programmierer zur Verfügung stehen, hängen davon ab, was ein MVPD zur Verfügung stellt. Siehe Benutzermetadaten für die aktuelle Liste der verfügbaren Benutzermetadaten.

Beispiel:

    // 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 {
            ...
      }
    }

Ausgelöste Rückrufe: setMetadataStatus()

Zurück zum Anfang

setSelectedProvider(providerId) setSelectedProvider

Beschreibung: Rufen Sie diese Funktion auf, wenn der Benutzer über die Benutzeroberfläche zur Anbieterauswahl einen MVPD ausgewählt hat, um die Anbieterauswahl an den Access Enabler zu senden, oder rufen Sie diese Funktion mit einem Nullparameter auf, falls der Benutzer die Benutzeroberfläche zur Anbieterauswahl ohne Auswahl eines Anbieters verworfen hat.

Ausgelöste Rückrufe: ​ setAuthentcationStatus(), sendTrackingData()

Zurück zum Anfang

getSelectedProvider() getSelectedProvider

Beschreibung: Ruft die Ergebnisse der Auswahl des Kunden im Dialogfeld zur Anbieterauswahl ab. Dies kann jederzeit nach der anfänglichen Authentifizierungsprüfung verwendet werden.

Diese Funktion ist asynchron und gibt ihr Ergebnis an Ihre selectedProvider() Callback-Funktion.

  • MVPD Der derzeit ausgewählte MVPD oder null, wenn kein MVPD ausgewählt wurde.
  • AE_State Das Ergebnis der Authentifizierung für den aktuellen Kunden lautet "Neuer Benutzer", "Benutzer nicht authentifiziert"oder "Benutzer authentifiziert".

Ausgelöste Rückrufe: selectedProvider()

Zurück zum Anfang

Abmelden logout

Beschreibung: Meldet den aktuellen Kunden ab und löscht alle Authentifizierungs- und Autorisierungsinformationen für diesen Benutzer. Löscht alle authN- und authZ-Token aus dem System des Kunden.

Ausgelöste Rückrufe: setAuthentcationStatus()

Zurück zum Anfang

Callback-Definition calllback-definitions

Sie müssen diese Rückrufe implementieren, um die Antworten auf Ihre asynchronen Anfrageaufrufe zu verarbeiten:

entitlementLoaded() entitlementLoaded

Beschreibung: Wird ausgelöst, wenn der Access Enabler die Initialisierung abgeschlossen hat und zum Empfang von Anfragen bereit ist. Implementieren Sie diesen Rückruf, um zu erfahren, wann Sie die Kommunikation mit der Access Enabler-API starten können.

Zurück zum Anfang

setConfig(configXML) setconfig(configXML)

Beschreibung: Implementieren Sie diesen Rückruf, um die Konfigurationsinformationen und die MVPD-Liste zu erhalten.

Parameter:

  • configXML: xml -Objekt, das die Konfiguration für den aktuellen ANFORDERER einschließlich der MVPD-Liste enthält.

Ausgelöst von: setRequestor()

Zurück zum Anfang

displayProviderDialog(providers) displayproviderdialog(providers)

Beschreibung: Implementieren Sie diesen Rückruf, um Ihre eigene benutzerdefinierte Benutzeroberfläche zur Anbieterauswahl aufzurufen. Ihr Dialogfeld sollte den Anzeigenamen (und das optionale Logo) verwenden, um die Auswahlmöglichkeiten des Kunden bereitzustellen. Wenn der Kunde eine Auswahl getroffen und das Dialogfeld abgelehnt hat, senden Sie die zugehörige ID für den ausgewählten Anbieter im Aufruf an setSelectedProvider().

Parameter:

  • Anbieter - Ein Array von Objekten, die die angeforderten MVPDs darstellen:
    var mvpd = {
        ID: "someprov",
        displayName: "Some Provider",
        logoURL: "http://www.someprov.com/images/logo.jpg"
    }

Ausgelöst von: getAuthentication(), getAuthorization()

Zurück zum Anfang

createIFrame(inWidth, inHeight) createIFrame(inWidth,inHeight)

Beschreibung: Implementieren Sie diesen Rückruf, wenn der Benutzer ein MVPD ausgewählt hat, für das ein iFrame erforderlich ist, in dem die zugehörige Anmeldeseite angezeigt werden soll.

Ausgelöst von: ​ setSelectedProvider()

Zurück zum Anfang

setAuthenticationStatus(isAuthenticated, errorCode) set-authn-status-isauthn-error

Beschreibung: Implementieren Sie diesen Rückruf, um den Authentifizierungsstatus (1=authentifiziert oder 0=nicht authentifiziert) und eine beschreibende Fehlermeldung zu erhalten, wenn beim Versuch, den Authentifizierungsstatus zu ermitteln, ein Fehler aufgetreten ist (leere Zeichenfolge nach erfolgreichem Abschluss der Prüfung).

NOTE
Wenn Sie die aktuelle Version verwenden, Fortschrittliche Fehlerberichte -System können Sie den an diese Funktion gesendeten Parameter errorCode ignorieren. Das isAuthenticated -Flaggschiff wird jedoch weiterhin zur Verfolgung des Authentifizierungsstatus eines Benutzers im Berechtigungsfluss verwendet

Parameter:

  • isAuthenticated - Authentifizierungsstatus: 1 (authentifiziert) oder 0 (nicht authentifiziert).
  • errorCode - Fehler, der bei der Bestimmung des Authentifizierungsstatus aufgetreten ist. Eine leere Zeichenfolge, wenn keine.

Ausgelöst von: checkAuthentication(), getAuthentication(), checkAuthorization()

Zurück zum Anfang

sendTrackingData(trackingEventType, trackingData) sendTrackingData(trackingEventType,trackingData)

CAUTION
Gerätetyp und Betriebssystem werden durch die Verwendung einer öffentlichen Java-Bibliothek (http://java.net/projects/user-agent-utils) und die Benutzeragenten-Zeichenfolge. Beachten Sie, dass diese Informationen nur als grobe Methode zur Unterteilung von Betriebsmetriken in Gerätekategorien bereitgestellt werden, dass Adobe jedoch keine Verantwortung für fehlerhafte Ergebnisse übernehmen kann. Verwenden Sie die neue Funktion entsprechend.

Beschreibung: Implementieren Sie diesen Rückruf, um Tracking-Daten zu empfangen, wenn bestimmte Ereignisse auftreten. Sie können dies beispielsweise verwenden, um zu verfolgen, wie viele Benutzer sich mit denselben Anmeldedaten angemeldet haben. Das Tracking ist derzeit nicht konfigurierbar. Mit Adobe Pass Authentication 1.6 sendTrackingData() enthält außerdem Informationen zum Gerät, zum Access Enabler-Client und zum Betriebssystemtyp. Die sendTrackingData() callback bleibt abwärtskompatibel.

  • Mögliche Werte für den Gerätetyp:

    • Computer
    • Tablet
    • mobile
    • Gameconsole
    • unknown

  • Mögliche Werte für den Client-Typ Access Enabler :

    • html5
    • iOS
    • Android

Übergibt den Ereignistyp und ein Array der zugehörigen Informationen. Ereignistypen sind:

mvpdSelection
Der Benutzer wählte ein MVPD in einem Anbieterauswahldialogfeld aus.
authenticationDetection
Eine Authentifizierungsprüfung ist abgeschlossen.
authorizationDetection
Eine Genehmigungsanfrage ist abgeschlossen.


Daten sind für jeden Ereignistyp spezifisch:

Ereignistyp (Zeichenfolge)
Daten (Array)
mvpdSelection
0: Ausgewählter MVPD
1: Gerätetyp
2: Auf Enabler-Client-Typ zugreifen
3: Betriebssystem
authenticationDetection
0: Ob die Token-Anfrage erfolgreich war (true/false)
1: MVPD ID
2: GUID
3: Token bereits im Cache (true/false)
4: Gerätetyp
5: Auf Enabler-Client-Typ zugreifen
6: Betriebssystem
authorizationDetection
0: Ob die Token-Anfrage erfolgreich war (true/false)
1: MVPD ID
2: GUID
3: Token bereits im Cache (true/false)
4: Fehler
5: Details
6: Gerätetyp
7: Auf Enabler-Client-Typ zugreifen
8: Betriebssystem

Ausgelöst von: checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization()

Zurück zum Anfang

setToken(inRequestedResourceID, inToken) setToken(inRequestedResourceID,inToken)

Beschreibung: Implementieren Sie diesen Rückruf, um das kurzlebige Medien-Token (inToken) und die Kennung der Ressource (inRequestedResourceID) zu erhalten, für die eine Autorisierungsanfrage oder eine Anfrage zur Autorisierung durchgeführt wurde und die erfolgreich abgeschlossen wurde.

Ausgelöst von: checkAuthorization(), getAuthorization()

Zurück zum Anfang

tokenRequestFailed(inRequestedResourceID, inRequestErrorCode, inRequestDetailedErrorMessage) token-request-failed-error-msg

Beschreibung: Implementieren Sie diesen Rückruf, der signalisiert werden soll, wenn eine Autorisierungs- oder Prüfautorisierungsanforderung fehlgeschlagen ist. Kann optional von einem MVPD verwendet werden, um eine benutzerdefinierte Nachricht bereitzustellen, die vom Programmierer angezeigt werden soll.

IMPORTANT
Diese Rückruffunktion ist Teil des älteren, ursprünglichen Adobe Pass-Authentifizierungsfehlermeldesystems. Sie wird aus Gründen der Abwärtskompatibilität beibehalten. Es ist jedoch nicht erforderlich, diese Funktion überhaupt zu verwenden, wenn Sie Ihre eigenen Rückrufe mit dem aktuellen erweiterten Fehlermeldesystem implementiert haben. Das neuere Fehlermeldesystem enthält detailliertere Informationen darüber, warum eine Autorisierung (oder ein anderer Vorgang) fehlgeschlagen ist, sowie empfohlene Vorgehensweisen für jeden Fehler- oder Warnungstyp.

Parameter:

  • inRequestedResourceID - Eine Zeichenfolge, die die Ressourcen-ID angibt, die für die Autorisierungsanforderung verwendet wurde.
  • inRequestErrorCode - Eine Zeichenfolge, die den Fehlercode für die Adobe Pass-Authentifizierung anzeigt und den Grund des Fehlers angibt. Mögliche Werte sind "User Not Authenticated Error"und "User Not Authorized Error"(Benutzer nicht autorisiert). Weitere Informationen finden Sie unten unter "Callback-Fehlercodes".
  • inRequestDetailedErrorMessage - Eine zusätzliche beschreibende Zeichenfolge, die für die Anzeige geeignet ist. Wenn diese beschreibende Zeichenfolge aus keinem Grund verfügbar ist, sendet die Adobe Pass-Authentifizierung eine leere Zeichenfolge (""). Dies kann von einem MVPD verwendet werden, um benutzerdefinierte Fehlermeldungen oder umsatzbezogene Nachrichten zu übergeben. Wenn beispielsweise einem Abonnenten die Autorisierung für eine Ressource verweigert wird, kann der MVPD mit einer *inRequestDetailedErrorMessage* wie: "Sie haben derzeit keinen Zugriff auf diesen Kanal in Ihrem Paket. Wenn Sie Ihr Paket aktualisieren möchten, klicken Sie auf *hier*." Die Nachricht wird von der Adobe Pass-Authentifizierung über diesen Rückruf an die Website des Programmierers übergeben. Der Programmierer hat dann die Möglichkeit, ihn anzuzeigen oder zu ignorieren. Die Adobe Pass-Authentifizierung kann auch verwendet werden *inRequestDetailedErrorMessage* , um den Programmierer über die Bedingung zu informieren, die möglicherweise zu einem Fehler geführt hat. Beispiel: "Bei der Kommunikation mit dem Autorisierungsdienst des Providers ist ein Netzwerkfehler aufgetreten."

Ausgelöst von: checkAuthorization(), getAuthorization()

Zurück zum Anfang

preauthorizedResources(authorizedResources) preauthorizedResources(authorizedResources)

Beschreibung: Durch den Access Enabler ausgelöster Rückruf, der die Liste der autorisierten Ressourcen bereitstellt, die nach einem Aufruf an checkPreauthorizedResources().

Parameter:

  • authorizedResources: Die Liste der autorisierten Ressourcen.

Ausgelöst von: checkPreauthorizedResources()

Zurück zum Anfang

setMetadataStatus(key, encrypted, data) setMetadataStatus(key,encrypted,data)

Beschreibung: Durch den Access Enabler ausgelöster Rückruf, der die über einen getMetadata() aufrufen.

Weitere Informationen: Benutzermetadaten

Parameter:

  • key (String): Der Schlüssel der Metadaten, für die die Anfrage ausgeführt wurde.
  • verschlüsselt (Boolesch): Eine Markierung, die angibt, ob der "Wert"verschlüsselt ist oder nicht. Wenn dies "true"ist, ist "value"tatsächlich eine JSON Web-verschlüsselte Darstellung des tatsächlichen Werts.
  • data (JSON-Objekt): Ein JSON-Objekt mit der Darstellung der Metadaten. Für einfache Anfragen ('TTL_AUTHN', 'TTL_AUTHZ', 'DEVICEID'), ist das Ergebnis eine Zeichenfolge (die die Authentifizierungs-TTL, die Autorisierungs-TTL oder die Geräte-ID darstellt). Bei einer User Metadata-Anfrage kann das Ergebnis ein Primitive- oder JSON-Objekt sein, das die Metadaten-Payload darstellt. Die tatsächliche Struktur der JSON-Benutzermetadatenobjekte ähnelt der folgenden:
    {
        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"]
    }

Beispiel:

    // 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);
    }

Ausgelöst von: getMetadata()


Zurück zum Anfang

selectedProvider(result) selectedProvider(result)

Beschreibung: Implementieren Sie diesen Rückruf, um das derzeit ausgewählte MVPD und das Ergebnis der Authentifizierung des aktuellen Benutzers zu erhalten, der in der result -Parameter. Die result -Parameter ist ein Objekt mit den folgenden Eigenschaften:

  • MVPD Der derzeit ausgewählte MVPD oder null, wenn kein MVPD ausgewählt wurde.
  • AE_state Das Ergebnis der Authentifizierung für den aktuellen Benutzer, einer von "New User", "User Not Authenticated" oder "User Authenticated"

Ausgelöst von: getSelectedProvider()

Zurück zum Anfang

Callback-Fehlercodes callback-error-codes

Allgemeine Fehler
Interner Fehler
Beim Versuch, eine Anfrage zu verarbeiten, ist ein Systemfehler aufgetreten.
Fehler bei Provider nicht ausgewählt
Tritt auf, wenn Kunden im Dialogfeld zur Anbieterauswahl abbrechen
Fehler bei Provider nicht verfügbar
Tritt auf, wenn keine Anbieter verfügbar sind.
Authentifizierungsfehler
Generischer Authentifizierungsfehler
Wird zurückgegeben, wenn der Grund nicht bekannt ist oder nicht veröffentlicht werden kann.
Interner Authentifizierungsfehler
Beim Authentifizierungsversuch ist ein Systemfehler aufgetreten.
Benutzer nicht authentifiziert Fehler
Der Benutzer ist nicht authentifiziert.
Fehler bei mehreren Authentifizierungsanforderungen
Zusätzliche Authentifizierungsanfragen wurden empfangen, bevor der erste abgeschlossen wurde.
Autorisierungsfehler
Allgemeiner Autorisierungsfehler
Wird zurückgegeben, wenn der Grund nicht bekannt ist oder nicht veröffentlicht werden kann.
Interner Autorisierungsfehler
Beim Autorisieren ist ein Systemfehler aufgetreten.
Benutzer nicht autorisiert Fehler
Der Kunde ist nicht berechtigt, den angeforderten Inhalt anzuzeigen.

Zurück zum Anfang

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b