Erste Schritte mit Adobe Experience Platform APIs

Adobe Experience Platform wird unter der Philosophie "API first"entwickelt. Mithilfe von Plattform-APIs können Sie grundlegende CRUD-Vorgänge (Erstellen, Lesen, Aktualisieren, Löschen) programmgesteuert 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 Stapel usw.

Die APIs für jeden Experience Platform-Dienst verwenden alle denselben Satz von Authentifizierungs-Headern und verwenden ähnliche Syntaxen für ihre CRUD-Vorgänge. In der folgenden Anleitung werden die erforderlichen Schritte für die ersten Schritte mit Plattform-APIs beschrieben.

Authentifizierung und Kopfzeilen

Damit Sie erfolgreich Aufrufe an Plattform-Endpunkte vornehmen können, müssen Sie das Authentifizierungstutorial 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-Anforderungen angezeigt, die von den API-Handbüchern für einzelne Plattformdienste bereitgestellt werden.

Grundlagen der Experience Platform-API

Adobe Experience Platform-APIs setzen verschiedene zugrunde liegende Technologien und Syntaxen ein, die für eine effiziente Verwaltung der Plattformressourcen wichtig sind.

Weitere Informationen zu den zugrunde liegenden API-Technologien, einschließlich JSON-Schema-Beispielobjekten, finden Sie im Handbuch Experience Platform API-Grundlagen.

Postman-Sammlungen für Experience Platform-APIs

Postman ist eine Kooperationsplattform für die API-Entwicklung, mit der Sie Umgebung mit voreingestellten Variablen einrichten, API-Sammlungen freigeben, CRUD-Anforderungen optimieren und mehr. Die meisten Plattform-API-Dienste verfügen über Postman-Sammlungen, mit denen API-Aufrufe durchgeführt werden können.

Weitere Informationen zu Postman, einschließlich der Einrichtung einer Umgebung, einer Liste verfügbarer Sammlungen und dem Importieren 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 an. 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 müssen den vollständigen Pfad verwenden, der in der Beispielanforderung angezeigt wird, wenn Sie Ihre eigenen Aufrufe an Plattform-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 Header entweder als Beispiel-Header-Werte oder als Variablen angezeigt, in die vertrauliche Informationen (wie Sicherheits-Token und Zugriffs-IDs) einbezogen werden sollten.

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 Plattformfehlerbehebung enthält eine Liste von Fehlern, die bei der Verwendung eines Experience Platform-Dienstes auftreten können.

Hinweise zur Fehlerbehebung bei einzelnen Plattformdiensten finden Sie im Ordner Dienstfehlerbehebung.

Weitere Informationen zu bestimmten Endpunkten in Plattform-APIs, einschließlich der erforderlichen Kopfzeilen und Anforderungskörper, finden Sie in den Plattform-API-Handbüchern.

API-Handbücher für Plattformen

API-Handbuch Beschreibung
Access Control API-Handbuch Der API-Endpunkt Access Control kann aktuelle Richtlinien abrufen, die für einen Benutzer bei bestimmten Ressourcen in einer angegebenen Sandbox gültig sind. Alle anderen Funktionen der Zugriffskontrolle werden über das Adobe Admin Console bereitgestellt.
Handbuch zur Batchaufnahme-API Mit der API Adobe Experience Platform Data Ingestion können Sie Daten als Batch-Dateien in Plattform erfassen. Daten, die erfasst werden, können die Profil-Daten aus einer einfachen Datei in einem CRM-System (z. B. einer Parquet-Datei) oder Daten sein, die einem bekannten Schema in der Schema Registry (XDM) entsprechen.
Catalog Service API-Handbuch Die Catalog Service-API ermöglicht Entwicklern die Verwaltung von DataSet-Metadaten in Adobe Experience Platform. Dazu gehören Datenspeicherorte, Verarbeitungsstufen, während der Verarbeitung aufgetretene Fehler und Datenberichte.
Data Access API-Handbuch Die Data Access-API ermöglicht es Entwicklern, Informationen zu erfassten Datensätzen innerhalb der Experience Platform abzurufen. Dazu gehören der Zugriff auf und das Herunterladen von Datensatzdateien, das Abrufen von Header-Informationen, das Auflisten fehlgeschlagener und erfolgreicher Stapel und das Herunterladen von CSV-/Parquet-Vorschauen.
Dataset Service API-Handbuch Mit der DataSet-Dienst-API können Sie Nutzungsbezeichnungen für Datensätze anwenden und bearbeiten. Es gehört zu den Funktionen des Adobe Experience Platform-Datenkatalogs, ist jedoch von der Katalogdienst-API getrennt, die die Metadaten des Datensatzes verwaltet.
Flow Service API-Handbuch
(Quellen und Ziele)
Die Flow Service-API wird zur Erfassung und Zentralisierung Ihrer Daten aus verschiedenen Quellen verwendet und dient zur Erstellung und Aktivierung von Daten an verschiedene Ziele in Adobe Experience Platform. Der Dienst stellt eine RESTful-API bereit, über die alle unterstützten Quellen verbunden werden können.
Identity Service API-Handbuch Die Identity Service-API ermöglicht es Entwicklern, geräteübergreifende, geräteübergreifende Kanal- und Echtzeitidentifizierung Ihrer Kunden mithilfe von Identitätsdiagrammen in Adobe Experience Platform zu verwalten.
Observability Insights API-Handbuch Observability Insights ist eine RESTful-API, mit der Entwickler wichtige Kennzeichnungsmetriken in Adobe Experience Platform verfügbar machen können. Diese Metriken liefern Einblicke in Statistiken zur Platform-Nutzung, Systemdiagnosen für Platform-Dienste, historische Trends und Leistungsindikatoren für verschiedene Platform-Funktionen.
Policy Service API-Handbuch
(Datenverwaltung)
Mit der API Policy Service können Sie Datenverwendungsbeschriftungen und -richtlinien erstellen und verwalten, um festzustellen, welche Marketingaktionen für Daten mit bestimmten Datenverwendungsbeschriftungen durchgeführt werden können. Informationen zum Anwenden von Bezeichnungen auf Datensätze und Felder finden Sie im Handbuch Dataset Service API
Privacy Service API-Handbuch Die Privacy Service-API ermöglicht es Entwicklern, Kundenanfragen zu erstellen und zu verwalten, um ihre personenbezogenen Daten in allen Experience Cloud-Anwendungen abzurufen oder zu löschen. Dabei gelten die gesetzlichen Datenschutzbestimmungen.
Query Service API-Handbuch Die Query Service-API ermöglicht Entwicklern die Abfrage ihrer Adobe Experience Platform-Daten mit Standard-SQL.
Real-time Customer Profile API-Handbuch Die Echtzeit-Client-Profil-API ermöglicht es Entwicklern, Profil-Daten zu untersuchen und mit ihnen zu arbeiten, einschließlich Anzeigen von Profilen, Erstellen und Aktualisieren von Zusammenführungsrichtlinien, Exportieren oder Sampling-Profil-Daten und Löschen von Profil-Daten, die nicht mehr benötigt werden oder fehlerhaft hinzugefügt wurden.
Handbuch zur Sandbox-API Die Sandbox-API ermöglicht es Entwicklern, isolierte Virtual Sandbox-Umgebung in Adobe Experience Platform programmgesteuert zu verwalten.
Schema Registry API-Handbuch
(XDM)
Die Schema Registry-API ermöglicht es Entwicklern, alle Schema und zugehörigen XDM-Ressourcen (Experience Data Model) innerhalb von Adobe Experience Platform programmatisch zu verwalten.
Segmentation Service API-Handbuch Die Segmentation Service-API ermöglicht es Entwicklern, Segmentierungsvorgänge in Adobe Experience Platform programmgesteuert zu verwalten. Dazu gehören das Erstellen von Segmenten und das Generieren von Audiencen aus Ihren Echtzeit-Daten zum Profil von Kunden.
Sensei Machine Learning API-Handbuch
(Data Science Workspace)
Die Sensei Machine Learning-API bietet Datenwissenschaftlern einen Mechanismus zum Organisieren und Verwalten von XML-Diensten (maschinelles Lernen), von der Algorithmusüberwachung über Experimentierung bis zur Dienstbereitstellung.

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

Nächste Schritte

In diesem Dokument wurden die erforderlichen Kopfzeilen und verfügbaren Handbücher vorgestellt und ein API-Beispielaufruf bereitgestellt. Nachdem Sie die erforderlichen Header-Werte für API-Aufrufe unter Adobe Experience Platform verwendet haben, wählen Sie in der Tabelle Plattform-API-Leitfäden einen API-Endpunkt aus, den Sie untersuchen möchten.

Antworten auf häufig gestellte Fragen finden Sie im Handbuch Plattformfehlerbehebung.

Um eine Postman-Umgebung einzurichten und die verfügbaren Postman-Sammlungen zu erkunden, lesen Sie das Platform Postman Guide.

Auf dieser Seite