Erste Schritte mit Adobe Experience Platform-APIs

Adobe Experience Platform wird unter der Philosophie "API first"entwickelt. Mit Platform-APIs können Sie programmatisch grundlegende CRUD-Vorgänge (Erstellen, Lesen, Aktualisieren, Löschen) für Daten durchführen, z. B. die Konfiguration berechneter Attribute, den Zugriff auf Daten/Entitäten, den Export von Daten, das Löschen nicht benötigter Daten oder Batches und mehr.

Die APIs für jeden Experience Platform-Dienst verwenden alle denselben Satz von Authentifizierungskopfzeilen und verwenden ähnliche Syntaxen für ihre CRUD-Vorgänge. Im folgenden Handbuch werden die erforderlichen Schritte für die ersten Schritte mit Platform-APIs beschrieben.

Authentifizierung und Kopfzeilen

Um Platform-Endpunkte erfolgreich aufrufen zu können, müssen Sie das Authentifizierungs-Tutorial abschließen. Im Rahmen des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Kopfzeilen in Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:

• Authorization: Bearer {ACCESS_TOKEN}
• x-api-key: {API_KEY}
• x-gw-ims-org-id: {IMS_ORG}

Sandbox-Kopfzeile

Alle Ressourcen in Experience Platform sind auf bestimmte virtuelle Sandboxes beschränkt. Für 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}

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

Content-Type-Kopfzeile

Alle Anfragen mit einer Payload im Anfragetext (wie POST-, PUT- und PATCH-Aufrufe) müssen eine Content-Type-Kopfzeile enthalten. Akzeptierte Werte sind für jeden API-Endpunkt spezifisch. Wenn ein bestimmter Content-Type -Wert für einen Endpunkt benötigt wird, wird sein Wert in den Beispiel-API-Anfragen angezeigt, die von den API-Handbüchern für einzelne Platform-Dienste bereitgestellt werden.

Grundlagen der Experience Platform-API

Adobe Experience Platform-APIs setzen verschiedene zugrunde liegende Technologien und Syntaxen ein, die für eine effektive Verwaltung von Platform-Ressourcen wichtig sind.

Weitere Informationen zu den zugrunde liegenden API-Technologien, die von Platform verwendet werden, einschließlich Beispiel-JSON-Schemaobjekten, finden Sie im Handbuch Grundlagen der Experience Platform-API .

Postman-Sammlungen für Experience Platform-APIs

Postman ist eine Kooperationsplattform für die API-Entwicklung, mit der Sie Umgebungen mit vordefinierten Variablen einrichten, API-Sammlungen freigeben, CRUD-Anforderungen optimieren und vieles mehr. Die meisten Platform-API-Dienste verfügen über Postman-Sammlungen, die beim Ausführen von API-Aufrufen verwendet werden können.

Weitere Informationen zu Postman, einschließlich der Einrichtung einer Umgebung, einer Liste der verfügbaren Sammlungen und des Imports von Sammlungen, finden Sie in der Platform Postman-Dokumentation.

Lesen von Beispiel-API-Aufrufen

Anfrageformate variieren je nach der verwendeten Platform-API. Am einfachsten erfahren Sie, wie Sie API-Aufrufe strukturieren können, indem Sie sich die in der Dokumentation die für einzelne Platform-Dienste angegebenen Beispiele ansehen.

Die Dokumentation für Experience Platform zeigt Beispiel-API-Aufrufe auf zwei verschiedene Arten. Zunächst wird der Aufruf im API-Format dargestellt, wobei es sich um eine Vorlagendarstellung handelt, die nur den Vorgang (GET, POST, PUT, PATCH, DELETE) und den verwendeten Endpunkt (z. B. /global/classes) zeigt. Manche Vorlagen zeigen auch die Stelle von Variablen an, um zu veranschaulichen, wie ein Aufruf formuliert werden sollte, z. B. GET /{VARIABLE}/classes/{ANOTHER_VARIABLE}.

Die Aufrufe werden dann als cURL-Befehle in einer Anfrage angezeigt, die die erforderlichen Kopfzeilen und den vollständigen „Basispfad“ enthält, die für eine erfolgreiche Interaktion mit der API erforderlich sind. Der Basispfad sollte allen Endpunkten vorangestellt werden. Der oben genannte Endpunkt /global/classes beispielsweise ändert sich in https://platform.adobe.io/data/foundation/schemaregistry/global/classes. Sie sehen das API-Format/Anforderungsmuster in der gesamten Dokumentation und sollten den vollständigen Pfad verwenden, der in der Beispielanfrage angezeigt wird, wenn Sie eigene Aufrufe an Platform-APIs durchführen.

Beispiel-API-Anfrage

Im Folgenden finden Sie eine Beispiel-API-Anfrage, die das Format veranschaulicht, mit dem Sie es in der Dokumentation zu tun haben werden.

API-Format

Das API-Format gibt Auskunft über den Vorgang (GET) und den verwendeten Endpunkt. Variablen werden durch geschweifte Klammern gekennzeichnet (in diesem Fall {CONTAINER_ID}).

GET /{CONTAINER_ID}/classes

Anfrage

In dieser Beispielanfrage werden den Variablen aus dem API-Format tatsächliche Werte im Anfragepfad zugewiesen. Darüber hinaus werden alle erforderlichen Kopfzeilen entweder als Beispiel-Kopfzeilenwerte oder Variablen angezeigt, in die vertrauliche Informationen (wie Sicherheits-Token und Zugriffs-IDs) einbezogen werden sollen.

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Die Antwort zeigt, was Sie nach einem erfolgreichen Aufruf an die API erwarten würden, je nach gesendeter Anfrage. Zum Teil ist die Antwort aus Platzgründen abgeschnitten, d. h. Sie können möglicherweise mehr Informationen oder zusätzliche Informationen zu den im Beispiel dargestellten Informationen sehen.

{
    "results": [
        {
            "title": "XDM ExperienceEvent",
            "$id": "https://ns.adobe.com/xdm/context/experienceevent",
            "meta:altId": "_xdm.context.experienceevent",
            "version": "1"
        },
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile",
            "meta:altId": "_xdm.context.profile",
            "version": "1"
        }
    ],
    "_links": {}
}

Fehlermeldungen

Das Handbuch zur Fehlerbehebung bei Platform enthält eine Liste von Fehlern, die bei der Verwendung von Experience Platform-Diensten auftreten können.

Informationen zur Fehlerbehebung bei einzelnen Platform-Diensten finden Sie im Ordner zur Fehlerbehebung bei Diensten.

Weitere Informationen zu bestimmten Endpunkten in Platform-APIs, einschließlich erforderlicher Kopfzeilen und Anfragetexte, finden Sie in den Plattform-API-Handbüchern.

Handbuch zur Platform-API

Weitere Informationen zu bestimmten Endpunkten und Vorgängen, die für jeden Dienst verfügbar sind, finden Sie in der API-Referenzdokumentation auf der Adobe I/O.

Nächste Schritte

In diesem Dokument wurden die erforderlichen Kopfzeilen und verfügbaren Handbücher vorgestellt und ein Beispiel für einen API-Aufruf bereitgestellt. Nachdem Sie nun über die erforderlichen Kopfzeilenwerte verfügen, um API-Aufrufe in Adobe Experience Platform durchzuführen, wählen Sie einen API-Endpunkt, den Sie untersuchen möchten, in der Tabelle Platform-API-Handbücher aus.

Antworten auf häufig gestellte Fragen finden Sie im Handbuch zur Fehlerbehebung bei Plattformen.

Informationen zum Einrichten einer Postman-Umgebung und zum Erkunden der verfügbaren Postman-Sammlungen finden Sie im Platform Postman-Handbuch.