Identity Service-API-Handbuch

Adobe Experience Platform Identity Service verwaltet die geräteübergreifende, kanalübergreifende und nahezu Echtzeit-Kundenidentifizierung in einem so genannten Identitätsdiagramm in 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 aus, die sich aus der Fragmentierung von Kundenprofildaten ergibt. Dies geschieht durch die Verknüpfung von Identitäten über Geräte und Systeme hinweg, in denen Kunden mit Ihrer Marke interagieren.
  • Real-time Customer Profile: Bietet ein einheitliches Verbraucherprofil in Echtzeit, das auf aggregierten Daten aus mehreren 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 erfolgreich Aufrufe an die Identity Service API.

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}
HINWEIS

Weitere Informationen zu Sandboxes in Platform finden Sie in der Sandbox-Übersichtsdokumentation.

Bei allen Anfragen mit einer Payload (POST, PUT, PATCH) ist eine zusätzliche Kopfzeile erforderlich:

  • Content-Type: application/json

regionenbasiertes Routing

Die Identity Service API verwendet regionenspezifische Endpunkte, für die die Einbeziehung einer {REGION} als Teil des Anfragepfads. Während der Bereitstellung Ihrer IMS-Organisation wird eine Region in Ihrem IMS-Org-Profil bestimmt und gespeichert. Durch Verwendung des richtigen Bereichs für jeden Endpunkt wird sichergestellt, dass alle Anfragen, die mit dem Identity Service Die API wird an die entsprechende Region weitergeleitet.

Derzeit werden zwei Regionen unterstützt von Identity Service APIs: VA7 und NLD2.

Die folgende Tabelle zeigt Beispielpfade mit Regionen:

Service Region: VA7 Region: NLD2
Identity Service API https://platform-va7.adobe.io/data/core/identity/ https://platform-nld2.adobe.io/data/core/identity/
Identity Namespace API https://platform-va7.adobe.io/data/core/idnamespace/ https://platform-nld2.adobe.io/data/core/idnamespace
HINWEIS

Anfragen, die ohne Angabe einer Region durchgeführt werden, können dazu führen, dass Aufrufe an die falsche Region weitergeleitet werden oder dass Aufrufe unerwartet fehlschlagen.

Wenn Sie die Region in Ihrem IMS-Org-Profil 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 Diensten verwendet werden, können auf zwei Arten ausgedrückt werden: zusammengesetzt oder XID.

Verbund-Identitäten sind Konstrukte, die sowohl den ID-Wert als auch den Namespace enthalten. Bei Verwendung von zusammengesetzten Identitäten kann der Namespace entweder mit einem Namen (namespace.code) oder ID (namespace.id).

Wenn eine Identität beibehalten wird, Identity Service generiert und weist dieser Identität eine Kennung zu, die als native ID oder XID bezeichnet wird. Alle Varianten von Cluster- und Mapping-APIs unterstützen sowohl zusammengesetzte Identitäten als auch XID in ihren Anfragen und Antworten. Einer der Parameter ist erforderlich - xid oder Kombination von [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. Wenn Sie also XID übergeben, haben 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 gesamte Funktionalität der Identity Service API. Die vollständige API finden Sie in der Swagger-API-Referenz.

HINWEIS

Alle zurückgegebenen Identitäten werden im nativen XID-Formular angezeigt, wenn in der Anfrage die native XID verwendet wird. Es wird empfohlen, das Formular ID/Namespace zu verwenden. Weitere Informationen finden Sie im Abschnitt zu Abrufen der XID für eine Identität.

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.

Auf dieser Seite