Identity Service-API-Handbuch
Adobe Experience Platform Identity Service verwaltet die geräte- und kanalübergreifende, nahezu in Echtzeit ausgeführte Identifizierung Ihrer Kunden in einem so genannten Identitätsdiagramm innerhalb von Adobe Experience Platform.
Erste Schritte
Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:
- Identity Service: Löst die grundlegende Herausforderung, die sich aus der Fragmentierung von Kundenprofildaten ergibt. Dies erfolgt durch die Überbrückung von Identitäten zwischen Geräten und Systemen, in denen Kunden mit Ihrer Marke interagieren.
- Real-Time Customer Profile: Bietet ein einheitliches Kundenprofil in Echtzeit, das auf aggregierten Daten aus verschiedenen Quellen basiert.
- Experience Data Model (XDM): Das standardisierte Framework, mit dem Kundenerlebnisdaten von Platform organisiert werden.
Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um die Identity Service-API erfolgreich aufrufen zu können.
Lesen von Beispiel-API-Aufrufen
In diesem Handbuch wird anhand von Beispielen für API-Aufrufe die korrekte Formatierung von Anfragen aufgezeigt. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anfrage-Payloads. Außerdem wird ein Beispiel für eine von der API im JSON-Format zurückgegebene Antwort bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform
Sammeln von Werten für erforderliche Kopfzeilen
Um Platform-APIs aufzurufen, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Header in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:
- Authorization: Bearer
{ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
Alle Ressourcen in Experience Platform sind auf bestimmte virtuelle Sandboxes beschränkt. Bei allen Anfragen an Platform-APIs ist eine Kopfzeile erforderlich, die den Namen der Sandbox angibt, in der der Vorgang ausgeführt werden soll:
- x-sandbox-name:
{SANDBOX_NAME}
Bei allen Anfragen mit einer Payload (POST, PUT, PATCH) ist eine zusätzliche Kopfzeile erforderlich:
- Content-Type: application/json
Regionsbasiertes Routing
Die Identity Service-API verwendet regionsspezifische Endpunkte, für die ein {REGION} als Teil des Anfragepfads eingeschlossen werden muss. Bei der Bereitstellung Ihrer Organisation wird eine Region innerhalb Ihres Unternehmensprofils bestimmt und gespeichert. Durch die Verwendung der richtigen Region für jeden Endpunkt wird sichergestellt, dass alle Anforderungen, die mithilfe der Identity Service-API gestellt werden, an die entsprechende Region weitergeleitet werden.
Derzeit werden zwei Regionen von Identity Service APIs unterstützt: VA7 und NLD2.
Die folgende Tabelle zeigt Beispielpfade mit Regionen:
Wenn Sie die Region in Ihrem Unternehmensprofil nicht finden können, wenden Sie sich an Ihren Systemadministrator, um Unterstützung zu erhalten.
Verwenden der Identity Service-API
Identitätsparameter, die in diesen Services verwendet werden, können auf zwei Arten ausgedrückt werden: zusammengesetzte oder XID.
Zusammengesetzte Identitäten sind Konstrukte, die sowohl den ID-Wert als auch den Namespace enthalten. Bei Verwendung von zusammengesetzten Identitäten kann der Namespace entweder nach Name (namespace.code) oder ID (namespace.id) bereitgestellt werden.
Wenn eine Identität beibehalten wird, generiert Identity Service und weist dieser Identität eine ID zu, die als native ID oder XID bezeichnet wird. Alle Varianten von Cluster- und Mapping-APIs unterstützen in ihren Anfragen und Antworten sowohl zusammengesetzte Identitäten als auch XID. Einer der Parameter ist erforderlich - xid oder Kombination aus [ns oder nsid] und id, um diese APIs zu verwenden.
Um die Payload in Antworten zu begrenzen, passen APIs ihre Antworten an den Typ des verwendeten Identitätskonstrukts an. Das heißt, wenn Sie eine XID übergeben, enthalten Ihre Antworten XIDs. Wenn Sie zusammengesetzte Identitäten übergeben, folgt die Antwort der in der Anfrage verwendeten Struktur.
Die Beispiele in diesem Dokument decken nicht die vollständige Funktionalität der Identity Service-API ab. Die vollständige API finden Sie in der Swagger-API-Referenz.
Nächste Schritte
Nachdem Sie die erforderlichen Anmeldedaten gesammelt haben, können Sie nun das restliche Entwicklerhandbuch lesen. Jeder Abschnitt enthält wichtige Informationen zu ihren Endpunkten und veranschaulicht Beispiel-API-Aufrufe zur Durchführung von CRUD-Vorgängen. Zu jedem Aufruf gehören das allgemeine API-Format, eine Beispielanfrage mit erforderlichen Kopfzeilen und ordnungsgemäß formatierten Payloads sowie eine Beispielantwort eines erfolgreichen Aufrufs.