[Ultimate]{class="badge positive"}
HTTP-API-Verbindung
Übersicht overview
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 use-cases
Mit dem HTTP-API-Ziel können Sie XDM-Profildaten und -Zielgruppen in generische 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 supported-audiences
In diesem Abschnitt wird beschrieben, welche Arten von Zielgruppen Sie an dieses Ziel exportieren können.
Exporttyp und -häufigkeit export-type-frequency
Beziehen Sie sich auf die folgende Tabelle, um Informationen zu Typ und Häufigkeit des Zielexports zu erhalten.
Voraussetzungen prerequisites
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.
Unterstützung und Zertifikat des mTLS-Protokolls mtls-protocol-support
Sie können Mutual Transport Layer Security (mTLS) verwenden, um erweiterte Sicherheit bei ausgehenden Verbindungen zu Ihren HTTP-API-Zielverbindungen zu gewährleisten.
mTLS ist eine End-to-End-Sicherheitsmethode für die gegenseitige Authentifizierung, die sicherstellt, dass beide Parteien, die Informationen austauschen, vor der Datenfreigabe diejenigen sind, für die sie sich ausgeben. mTLS umfasst einen zusätzlichen Schritt im Vergleich zu TLS, bei dem der Server auch nach dem Zertifikat des Clients fragt und es an seinem Ende überprüft.
Wenn Sie mTLS mit HTTP API Zielen verwenden möchten, müssen für die Server-Adresse, die Sie auf der Seite Zieldetails eingeben, TLS Protokolle deaktiviert und nur aktiviert mTLS. Wenn das Protokoll TLS 1.2 noch auf dem Endpunkt aktiviert ist, wird kein Zertifikat für die Client-Authentifizierung gesendet. Das bedeutet, dass Ihr Empfangs-Server-Endpunkt ein mTLS-fähiger Verbindungsendpunkt sein muss, um mTLS mit Ihrem HTTP API-Ziel verwenden zu können.
Abrufen und Überprüfen von Zertifikatdetails certificate
Wenn Sie Zertifikatdetails wie die Common Name (CN) und Subject Alternative Names (SAN) auf zusätzliche Validierungen durch Dritte überprüfen möchten, verwenden Sie die API, um das Zertifikat abzurufen und diese Felder aus der Antwort zu extrahieren.
Weitere Informationen finden in derzum öffentlichen Zertifikatendpunkt .
Zulassungsliste von IP-Adressen ip-address-allowlist
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 IP-Adressen-Zulassungsliste für StreamingZiele, um die vollständige Liste der IPs in der Zulassungsliste aufzurufen.
Unterstützte Authentifizierungstypen supported-authentication-types
Das HTTP-API-Ziel unterstützt mehrere Authentifizierungstypen für Ihren HTTP-Endpunkt:
- HTTP-Endpunkt ohne Authentifizierung;
- Authentifizierung mit Bearer-Token;
- Client-Anmeldeinformationen für OAuth 2.0 Authentifizierung mit dem Textkörper-Formular, mit client ID, client secret und grant type im Textkörper der HTTP-Anfrage, 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>'
- Anmeldedaten für OAuth 2.0 mit einfacher Autorisierung, mit einer Autorisierungskopfzeile, die URL-codierte client ID und client secret enthält.
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 connect-destination
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 authentication-information
Authentifizierung über Bearer-Token bearer-token-authentication
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:
- Bearer-Token: Fügen Sie das Bearer-Token ein, um sich bei Ihrer HTTP-Adresse zu authentifizieren.
Keine Authentifizierung no-authentication
Wenn Sie keinen Authentifizierungstyp zum Herstellen einer Verbindung mit Ihrem HTTP-Endpunkt auswählen:
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 oauth-2-password-authentication
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:
- 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.
Authentifizierung mit Client-Anmeldedaten für OAuth 2 oauth-2-client-credentials-authentication
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:
-
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-Anmeldedaten: Wählen Sie den Typ der von Ihrem Endpunkt unterstützten Client-Anmeldedaten 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 destination-details
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.
- 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¶meter2=value
. - Segmentnamen einschließen: Schalten Sie diese Option ein, wenn der Datenexport die Namen der zu exportierenden Zielgruppen enthalten soll. 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 diese Option ein, wenn der Datenexport den UNIX-Zeitstempel enthalten soll, an dem die Zielgruppen erstellt und aktualisiert wurden, sowie den UNIX-Zeitstempel, an dem die Zielgruppen dem Ziel für die Aktivierung 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 enable-alerts
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 activate
- Zum Aktivieren von Daten benötigen Sie die Berechtigungen Ziele anzeigen, Ziele aktivieren, Profile anzeigen und Segmente anzeigen Zugriffssteuerung. Lesen Sie die Übersicht über die Zugriffssteuerung oder wenden Sie sich an Ihre Produktadmins, um die erforderlichen Berechtigungen zu erhalten.
- Bewertung der Einverständnisrichtlinie wird derzeit nicht in Exporten an das HTTP-API-Ziel unterstützt. Weitere Informationen.
Anweisungen Aktivieren von Zielgruppen für dieses Ziel finden Sie„Aktivieren von Zielgruppendaten für Streaming Profilexportziele“.
Zielattribute attributes
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 profile-export-behavior
Experience Platform optimiert das Verhalten beim Profilexport für Ihr HTTP-API-Ziel, sodass nur Daten an Ihren API-Endpunkt exportiert werden, wenn relevante Profilaktualisierungen nach der Zielgruppen-Qualifizierung oder anderen wichtigen Ereignissen durchgeführt wurden. 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 dem Ziel zugeordneten 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? what-determines-export-what-is-included
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.
- Zugeordnete Attribute und Segmente dienen als Hinweis für einen Zielexport. Das bedeutet, dass ein Zielexport gestartet wird, wenn sich der
segmentMembership
eines Profils inrealized
oderexiting
ändert oder 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 das Segment, das im Aktivierungsdatenfluss zugeordnet ist und für das sich der Status des Profils nach einem Qualifikations- oder Segmentaustrittsereignis geändert hat. Beachten Sie, dass andere nicht zugeordnete Segmente, für die sich das Profil qualifiziert hat, Teil des Zielexports sein können, wenn diese Segmente zu derselben Zusammenführungsrichtlinie wie das im Aktivierungsdatenfluss zugeordnete Segment gehören. - 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 Profilexport an das Ziel kann durch ein Profil bestimmt werden, das sich für eines der drei zugeordneten Segmente qualifiziert. Im Datenexport jedoch können im segmentMembership
(siehe Exportierte Daten Abschnitt unten) weitere nicht zugeordnete Zielgruppen angezeigt werden, wenn dieses bestimmte Profil zu diesen Profil gehört und diese Zielgruppen dieselbe Zusammenführungsrichtlinie verwenden wie die Zielgruppe, die den Export ausgelöst hat. Wenn ein Profil sich für das Segment Kunde mit DeLorean-Autos qualifiziert hat, aber auch Mitglied der Segmente Hat „Zurück in die Zukunft“ und Science-Fiction-" ist, sind diese beiden anderen Zielgruppen ebenfalls im segmentMembership
des Datenexports vorhanden, obwohl diese nicht im Datenfluss zugeordnet sind, falls diese dieselbe Zusammenführungsrichtlinie wie das Segment Kunde mit DeLorean-Autos verwenden.
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 historical-data-backfill
Wenn Sie eine neue Zielgruppe zu einem vorhandenen Ziel hinzufügen oder wenn Sie ein neues Ziel erstellen und diesem Zielgruppen zuordnen, exportiert Experience Platform historische Zielgruppen-Qualifizierungsdaten an das Ziel. Profile, die sich für die Zielgruppe qualifiziert haben zuvor wurde die Zielgruppe zum Ziel hinzugefügt, werden innerhalb von etwa einer Stunde an das Ziel exportiert.
Exportierte Daten exported-data
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.
segmentMembership
.code language-json |
---|
|
segmentMembership
.code language-json |
---|
|
Beschränkungen und Wiederholungsrichtlinien limits-retry-policy
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.