Ultimate

HTTP-API-Verbindung

Letzte Aktualisierung: 2024-01-22
  • Erstellt für:
  • Admin
    User

Übersicht

WICHTIG

Dieses Ziel ist nur für Kunden von Adobe Real-time Customer Data Platform Ultimate verfügbar.

Das HTTP-API-Ziel ist ein Streaming-Ziel von Adobe Experience Platform, mit dem Sie Profildaten an HTTP-Endpunkte von Drittanbietern senden können.

Um Profildaten an HTTP-Endpunkte zu senden, müssen Sie in Adobe Experience Platform zunächst eine Verbindung zum Ziel herstellen.

Anwendungsbeispiele

Mit dem HTTP-API-Ziel können Sie XDM-Profildaten und -Zielgruppen in allgemeine HTTP-Endpunkte exportieren. Dort können Sie Ihre eigenen Analysen oder beliebige andere Vorgänge ausführen, die Sie für aus Experience Platform exportierte Profildaten benötigen.

HTTP-Endpunkte können entweder eigene Systeme von Kunden oder Lösungen von Drittanbietern sein.

Unterstützte Zielgruppen

In diesem Abschnitt wird beschrieben, welche Zielgruppentypen Sie an dieses Ziel exportieren können.

Audience Origin Unterstützt Beschreibung
Segmentation Service Über die Experience Platform generierte Zielgruppen Segmentierungsdienst.
Benutzerdefinierte Uploads Zielgruppen, die aus CSV-Dateien in Experience Platform importiert werden.

Exporttyp und -häufigkeit

Beziehen Sie sich auf die folgende Tabelle, um Informationen zu Typ und Häufigkeit des Zielexports zu erhalten.

Element Typ Anmerkungen
Exporttyp Profilbasiert Sie exportieren alle Mitglieder eines Segments zusammen mit den gewünschten Schemafeldern (wie etwa E-Mail-Adresse, Telefonnummer, Nachname), wie im Bildschirm „Zuordnung“ im Zielaktivierungs-Workflow festgelegt.
Exporthäufigkeit Streaming Streaming-Ziele sind „immer verfügbare“ API-basierte Verbindungen. Sobald ein Profil in Experience Platform auf der Grundlage einer Zielgruppenauswertung aktualisiert wird, sendet der Connector das Update nachgelagert an die Zielplattform. Lesen Sie mehr über Streaming-Ziele.

Voraussetzungen

Um Daten aus Experience Platform mithilfe des HTTP-API-Ziels zu exportieren, müssen folgende Voraussetzungen erfüllt sein:

  • Sie müssen über einen HTTP-Endpunkt verfügen, der die REST-API unterstützt.
  • Ihr HTTP-Endpunkt muss das Profilschema von Experience Platform unterstützen. Im HTTP-API-Ziel wird keine Umwandlung in ein Payload-Schema von Drittanbietern unterstützt. Im Abschnitt exportierte Daten finden Sie ein Beispiel für das Ausgabeschema von Experience Platform.
  • Ihr HTTP-Endpunkt muss Kopfzeilen unterstützen.
TIPP

Sie können auch das Adobe Experience Platform Destination SDK verwenden, um eine Integration einzurichten und Profildaten von Experience Platform an einen HTTP-Endpunkt zu senden.

Zulassungsliste von IP-Adressen

Um die Sicherheits- und Compliance-Anforderungen von Kunden zu erfüllen, stellt Experience Platform eine Liste mit statischen IPs bereit, die Sie für das HTTP-API-Ziel auf die Zulassungsliste setzen können. Siehe Abschnitt IP-Adressen-Zulassungsliste für Streaming-Ziele für die vollständige Liste der IP-Adressen in auf die Zulassungsliste setzen.

Unterstützte Authentifizierungstypen

Das HTTP-API-Ziel unterstützt mehrere Authentifizierungstypen für Ihren HTTP-Endpunkt:

  • HTTP-Endpunkt ohne Authentifizierung;
  • Authentifizierung mit Bearer-Token;
  • OAuth 2.0-Client-Anmeldeinformationen Authentifizierung mit dem Hauptteilformular, mit client ID, client secret, und grant type im Hauptteil der HTTP-Anforderung, wie im folgenden Beispiel gezeigt.
curl --location --request POST '<YOUR_API_ENDPOINT>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=<CLIENT_ID>' \
--data-urlencode 'client_secret=<CLIENT_SECRET>'
curl --location --request POST 'https://some-api.com/token' \
--header 'Authorization: Basic base64(clientId:clientSecret)' \
--header 'Content-type: application/x-www-form-urlencoded; charset=UTF-8' \
--data-urlencode 'grant_type=client_credentials'

Herstellen einer Verbindung mit dem Ziel

WICHTIG

Um eine Verbindung zum Ziel herzustellen, benötigen Sie die Ziele anzeigen und Ziele verwalten Zugriffssteuerungsberechtigungen. Lesen Sie die Zugriffskontrolle – Übersicht oder wenden Sie sich an Ihren Produktadministrator, um die erforderlichen Berechtigungen zu erhalten.

Um eine Verbindung mit diesem Ziel herzustellen, gehen Sie wie im Tutorial zur Zielkonfiguration beschrieben vor. Beim Herstellen einer Verbindung zu diesem Ziel müssen Sie die folgenden Informationen angeben:

Authentifizierungsinformationen

Authentifizierung über Bearer-Token

Wenn Sie den Authentifizierungstyp Bearer-Token für die Verbindung zu Ihrem HTTP-Endpunkt wählen, füllen Sie die Felder unten aus und wählen Sie Mit Ziel verbinden:

Bild des UI-Bildschirms, auf dem Sie mithilfe der Authentifizierung des Trägertokens eine Verbindung zum HTTP-API-Ziel herstellen können.

  • Bearer-Token: Fügen Sie das Bearer-Token ein, um sich bei Ihrer HTTP-Adresse zu authentifizieren.

Keine Authentifizierung

Wenn Sie keinen Authentifizierungstyp zum Herstellen einer Verbindung mit Ihrem HTTP-Endpunkt auswählen:

Bild des UI-Bildschirms, auf dem Sie ohne Authentifizierung eine Verbindung zum HTTP-API-Ziel herstellen können.

Wenn Sie diese offene Authentifizierung auswählen, brauchen Sie nur auf Mit Ziel verbinden zu klicken, und die Verbindung zu Ihrem Endpunkt wird hergestellt.

Passwort-Authentifizierung für OAuth 2

Wenn Sie für die Verbindung zu Ihrem HTTP-Endpunkt den Authentifizierungstyp OAuth 2 mit Passwort wählen, füllen Sie die unten stehenden Felder aus und klicken Sie auf Mit Ziel verbinden:

Bild des UI-Bildschirms, auf dem Sie mithilfe von OAuth 2 mit Passwortauthentifizierung eine Verbindung zum HTTP-API-Ziel herstellen können.

  • Zugriffstoken-URL: Die URL auf Ihrer Seite, die Zugriffstoken ausgibt und Token optional aktualisiert.
  • Client-ID: Die client ID, die Ihr System Adobe Experience Platform zuweist.
  • Client-Geheimnis: Das client secret, das Ihr System Adobe Experience Platform zuweist.
  • Benutzername: Der Benutzername für den Zugriff auf Ihren HTTP-Endpunkt.
  • Passwort: Das Passwort für den Zugriff auf Ihren HTTP-Endpunkt.

Authenifizierung mit Client-Anmeldeinformationen für OAuth 2

Wenn Sie den Authentifizierungstyp Client-Anmeldeinformationen für OAuth 2 wählen, um sich mit Ihrem HTTP-Endpunkt zu verbinden, füllen Sie die unten stehenden Felder aus und klicken Sie auf Mit Ziel verbinden:

Bild des UI-Bildschirms, auf dem Sie mithilfe von OAuth 2 mit Client-Anmeldedaten-Authentifizierung eine Verbindung zum HTTP-API-Ziel herstellen können.

  • Zugriffstoken-URL: Die URL auf Ihrer Seite, die Zugriffstoken ausgibt und Token optional aktualisiert.
  • Client-ID: Die client ID, die Ihr System Adobe Experience Platform zuweist.
  • Client-Geheimwort: Das client secret, das Ihr System Adobe Experience Platform zuweist.
  • Typ der Client-Anmeldeinformationen: Wählen Sie den Typ der von Ihrem Endpunkt unterstützten Client-Anmeldeinformationen für OAuth2 aus:
    • Im Textkörper codiert: In diesem Fall sind client ID und client secret im Textkörper der Anfrage enthalten, die an Ihr Ziel gesendet wird… Ein Beispiel finden Sie im Abschnitt unterstützte Authentifizierungstypen.
    • Einfache Autorisierung: In diesem Fall werden client ID und client secret, nachdem sie mit Base64 codiert wurden, in eine Authorization-Kopfzeile aufgenommen und an Ihr Ziel gesendet. Ein Beispiel finden Sie im Abschnitt Unterstützte Authentifizierungstypen.

Ausfüllen der Zieldetails

Füllen Sie die folgenden erforderlichen und optionalen Felder aus, um Details für das Ziel zu konfigurieren. Ein Sternchen neben einem Feld in der Benutzeroberfläche zeigt an, dass das Feld erforderlich ist.

Bild des UI-Bildschirms mit ausgefüllten Feldern für die HTTP-Zieldetails.

  • Name: Geben Sie einen Namen ein, um dieses Ziel in Zukunft zu erkennen.
  • Beschreibung: Geben Sie eine Beschreibung ein, die Ihnen hilft, dieses Ziel in Zukunft zu identifizieren.
  • Kopfzeilen: Geben Sie alle benutzerdefinierten Kopfzeilen ein, die in die Ziel-Aufrufe aufgenommen werden sollen. Verwenden Sie dazu folgendes Format: header1:value1,header2:value2,...headerN:valueN.
  • HTTP-Endpunkt: Die URL des HTTP-Endpunkts, an den Sie die Profildaten senden möchten.
  • Abfrageparameter: Optional können Sie Abfrageparameter zur HTTP-Endpunkt-URL hinzufügen. Formatieren Sie die verwendeten Abfrageparameter wie folgt: parameter1=value&parameter2=value.
  • Segmentnamen einschließen: Schalten Sie ein, wenn der Datenexport die Namen der Zielgruppen enthalten soll, die exportiert werden sollen. Ein Beispiel für einen Datenexport, bei dem diese Option aktiviert ist, finden Sie im Abschnitt Exportierte Daten weiter unten.
  • Segmentzeitstempel einschließen: Schalten Sie ein, wenn der Datenexport zum Zeitpunkt der Erstellung und Aktualisierung der Zielgruppen den UNIX-Zeitstempel sowie den UNIX-Zeitstempel enthalten soll, zu dem die Zielgruppen zur Aktivierung dem Ziel zugeordnet wurden. Ein Beispiel für einen Datenexport, bei dem diese Option aktiviert ist, finden Sie im Abschnitt exportierte Daten weiter unten.

Aktivieren von Warnhinweisen

Sie können Warnhinweise aktivieren, um Benachrichtigungen zum Status des Datenflusses zu Ihrem Ziel zu erhalten. Wählen Sie einen Warnhinweis aus der zu abonnierenden Liste aus, um Benachrichtigungen über den Status Ihres Datenflusses zu erhalten. Weitere Informationen zu Warnhinweisen finden Sie im Handbuch zum Abonnieren von Zielwarnhinweisen über die Benutzeroberfläche.

Wenn Sie alle Details für Ihre Zielverbindung eingegeben haben, klicken Sie auf Weiter.

Aktivieren von Zielgruppen für dieses Ziel

WICHTIG

Siehe Aktivieren von Zielgruppendaten für Streaming-Profil-Export-Ziele für Anweisungen zum Aktivieren von Zielgruppen für dieses Ziel.

Zielattribute

Im Schritt Attribute auswählen empfiehlt Adobe, eine eindeutige Kennung aus Ihrem Vereinigungsschema auszuwählen. Wählen Sie die eindeutige Kennung und alle anderen XDM-Felder aus, die Sie an das Ziel exportieren möchten.

Profilexportverhalten

Experience Platform optimiert das Verhalten des Profilexports an Ihr HTTP-API-Ziel, sodass nur Daten an Ihren API-Endpunkt exportiert werden, wenn nach der Zielgruppenqualifizierung oder anderen wichtigen Ereignissen relevante Aktualisierungen an einem Profil stattgefunden haben. Profile werden in den folgenden Situationen an Ihr Ziel exportiert:

  • Die Aktualisierung des Profils wurde durch eine Änderung der Zielgruppenzugehörigkeit für mindestens eine der Zielgruppen bestimmt. Beispielsweise hat sich das Profil für eine der Zielgruppen qualifiziert, die dem Ziel zugeordnet sind, oder es hat eine der dem Ziel zugeordneten Zielgruppen verlassen.
  • Die Aktualisierung des Profils wurde durch eine Änderung der Identitätszuordnung bestimmt. Beispielsweise wurde einem Profil, das sich bereits für eine der dem Ziel zugeordneten Zielgruppen qualifiziert hatte, eine neue Identität im Identitätszuordnungsattribut hinzugefügt.
  • Die Aktualisierung des Profils wurde durch eine Änderung der Attribute für mindestens eines der dem Ziel zugeordneten Attribute bestimmt. Beispielsweise wird eines der Attribute, die dem Ziel im Zuordnungsschritt zugeordnet sind, einem Profil hinzugefügt.

In allen oben beschriebenen Fällen werden nur die Profile exportiert, in denen relevante Aktualisierungen vorgenommen wurden. Wenn beispielsweise eine Zielgruppe, die dem Zielfluss zugeordnet ist, aus hundert Mitgliedern besteht und fünf neue Profile sich für das Segment qualifizieren, ist der Export in Ihr Ziel inkrementell und umfasst nur die fünf neuen Profile.

Beachten Sie, dass alle zugeordneten Attribute unabhängig von der Art der Änderungen für ein Profil exportiert werden. Daher werden im obigen Beispiel alle zugeordneten Attribute für diese fünf neuen Profile exportiert, selbst wenn sich die Attribute selbst nicht geändert haben.

Was bestimmt einen Datenexport und was ist im Export enthalten?

Was die Daten betrifft, die für ein bestimmtes Profil exportiert werden, ist es wichtig, die beiden verschiedenen Konzepte zu verstehen, nämlich was den Datenexport an Ihr HTTP-API-Ziel bestimmt und welche Daten im Export enthalten sind.

Was einen Zielexport bestimmt Im Zielexport enthaltene Informationen
  • Zugeordnete Attribute und Zielgruppen dienen als Hinweis für einen Zielexport. Das bedeutet, dass ein Zielexport ausgelöst wird, wenn sich der Status einer zugeordneten Zielgruppe ändert (von null auf realized oder von realized auf exiting) oder wenn zugeordnete Attribute aktualisiert werden.
  • Da Identitäten derzeit nicht HTTP-API-Zielen zugeordnet werden können, bestimmen Änderungen an der Identität eines bestimmten Profils auch die Zielexporte.
  • Als Änderung für ein Attribut wird jede Aktualisierung des Attributs definiert, unabhängig davon, ob es sich um denselben Wert handelt oder nicht. Das bedeutet, dass das Überschreiben eines Attributs als Änderung gilt, selbst wenn sich der Wert selbst nicht geändert hat.
  • Das segmentMembership-Objekt enthält die Zielgruppe, die im Aktivierungsdatenfluss zugeordnet ist und für die sich der Status des Profils nach einem Qualifikations- oder Zielgruppenaustrittsereignis geändert hat. Beachten Sie, dass andere nicht zugeordnete Zielgruppen, für die sich das Profil qualifiziert hat, Teil des Zielexports sein können, wenn diese Zielgruppen zu derselben Zusammenführungsrichtlinie gehören wie die im Aktivierungsdatenfluss zugeordnete Zielgruppe.
  • Alle Identitäten im identityMap-Objekt sind ebenfalls enthalten (Experience Platform unterstützt derzeit keine Identitätszuordnung im HTTP-API-Ziel).
  • Nur die zugeordneten Attribute werden in den Zielexport einbezogen.

Betrachten Sie beispielsweise den folgenden Datenfluss an ein HTTP-Ziel, bei dem im Datenfluss drei Zielgruppen ausgewählt und dem Ziel vier Attribute zugeordnet sind.

Ein Beispiel für einen HTTP-API-Ziel-Datenfluss.

Ein Profilexport an das Ziel kann durch ein Profil bestimmt werden, das sich für eines der drei zugeordneten Segmente qualifiziert. Im Datenexport jedoch wird im segmentMembership -Objekt (siehe Exportierte Daten unten), können weitere nicht zugeordnete Zielgruppen angezeigt werden, wenn dieses bestimmte Profil Mitglied dieser Zielgruppe ist und diese dieselbe Zusammenführungsrichtlinie wie die Zielgruppe nutzen, die den Export ausgelöst hat. Wenn ein Profil für die Kunde mit DeLorean Cars -Segment, ist aber auch Mitglied der "Zurück in die Zukunft" Film und Fans von Science-Fiction Segmente verwenden, sind diese beiden anderen Zielgruppen auch im segmentMembership -Objekt des Datenexports, auch wenn diese nicht im Datenfluss zugeordnet sind, wenn diese dieselbe Zusammenführungsrichtlinie mit der Kunde mit DeLorean Cars Segment.

Aus Sicht der Profilattribute bestimmen alle Änderungen an den vier oben zugeordneten Attributen einen Zielexport, und eines der vier im Profil vorhandenen zugeordneten Attribute wird im Datenexport vorhanden sein.

Aufstockung historischer Daten

Wenn Sie eine neue Zielgruppe zu einem vorhandenen Ziel hinzufügen oder wenn Sie ein neues Ziel erstellen und ihm Zielgruppen zuordnen, exportiert Experience Platform historische Zielgruppenqualifizierungsdaten an das Ziel. Profile, die sich für die Zielgruppe qualifiziert haben before die Zielgruppe, die zum Ziel hinzugefügt wurde, innerhalb von etwa einer Stunde an das Ziel exportiert werden.

Exportierte Daten

Ihre exportierten Experience Platform-Daten landen in Ihrem HTTP-Ziel im JSON-Format. Beispielsweise enthält der folgende Export ein Profil, das sich für ein bestimmtes Segment qualifiziert hat, Mitglied zweier weiterer Segmente ist und ein weiteres Segment verlassen hat. Der Export umfasst außerdem Vorname, Nachname, Geburtsdatum und persönliche E-Mail-Adresse des Profilattributs. Die Identitäten für dieses Profil sind ECID und E-Mail.

{
  "person": {
    "birthDate": "YYYY-MM-DD",
    "name": {
      "firstName": "John",
      "lastName": "Doe"
    }
  },
  "personalEmail": {
    "address": "john.doe@acme.com"
  },
  "segmentMembership": {
   "ups":{
      "7841ba61-23c1-4bb3-a495-00d3g5fe1e93":{
         "lastQualificationTime":"2022-01-11T21:24:39Z",
         "status":"exited"
      },
      "59bd2fkd-3c48-4b18-bf56-4f5c5e6967ae":{
         "lastQualificationTime":"2022-01-02T23:37:33Z",
         "status":"realized"
      },
      "947c1c46-008d-40b0-92ec-3af86eaf41c1":{
         "lastQualificationTime":"2021-08-25T23:37:33Z",
         "status":"realized"
      },
      "5114d758-ce71-43ba-b53e-e2a91d67b67f":{
         "lastQualificationTime":"2022-01-11T23:37:33Z",
         "status":"realized"
      }
   }
},
  "identityMap": {
    "ecid": [
      {
        "id": "14575006536349286404619648085736425115"
      },
      {
        "id": "66478888669296734530114754794777368480"
      }
    ],
    "email_lc_sha256": [
      {
        "id": "655332b5fa2aea4498bf7a290cff017cb4"
      },
      {
        "id": "66baf76ef9de8b42df8903f00e0e3dc0b7"
      }
    ]
  }
}

Im Folgenden finden Sie weitere Beispiele für exportierte Daten, abhängig von den Benutzeroberflächeneinstellungen, die Sie im Fluss „Ziel verbinden“ für die Optionen Segmentnamen einschließen und Zeitstempel für Segmente einschließen auswählen.

 Im folgenden Beispiel für den Datenexport finden Sie Zielgruppennamen im segmentMembership Abschnitt
"segmentMembership": {
        "ups": {
          "5b998cb9-9488-4ec3-8d95-fa8338ced490": {
            "lastQualificationTime": "2019-04-15T02:41:50+0000",
            "status": "realized",
            "createdAt": 1648553325000,
            "updatedAt": 1648553330000,
            "mappingCreatedAt": 1649856570000,
            "mappingUpdatedAt": 1649856570000,
            "name": "First name equals John"
          }
        }
      }
 Das folgende Beispiel für den Datenexport enthält Zeitstempel der Zielgruppe im segmentMembership Abschnitt
"segmentMembership": {
        "ups": {
          "5b998cb9-9488-4ec3-8d95-fa8338ced490": {
            "lastQualificationTime": "2019-04-15T02:41:50+0000",
            "status": "realized",
            "createdAt": 1648553325000,
            "updatedAt": 1648553330000,
            "mappingCreatedAt": 1649856570000,
            "mappingUpdatedAt": 1649856570000,
          }
        }
      }

Beschränkungen und Wiederholungsrichtlinien

Experience Platform versucht, in 95 Prozent der Fälle eine Durchsatzlatenz von weniger als 10 Minuten für erfolgreich gesendete Nachrichten mit einer Rate von weniger als 10.000 Anfragen pro Sekunde für jeden Datenfluss an ein HTTP-Ziel zu bieten.

Bei fehlgeschlagenen Anfragen an Ihr HTTP-API-Ziel speichert Experience Platform die fehlgeschlagenen Anfragen und versucht es zweimal erneut, die Anfragen an Ihren Endpunkt zu senden.

Auf dieser Seite