In diesem Leitfaden erfahren Sie alles über Adobe Customer Journey Analytics (CJA) APIs – von der effizienten Datenextraktion und individuellen Lösungen bis hin zur Integration von Drittanbietern. Sie erhalten Informationen zum Setup, zu API-Schlüsseln, zum Testen mit Postman, zu einem Schritt-für-Schritt-Beispiel für einen API-Aufruf sowie hilfreiche Tipps für Einsteiger.

Sind Sie neu im Umgang mit APIs und fragen sich, wie Adobe Customer Journey Analytics (CJA) APIs Ihnen weiterhelfen können? Kein Grund zur Sorge! In diesem Einsteiger-Leitfaden führen wir Sie durch die wichtigsten Grundlagen, erklären die Fachbegriffe und unterstützen Sie dabei, Ihre ersten Schritte in die spannende Welt der CJA APIs zu machen.

Stellen Sie sich vor, Sie können Ihre CJA Daten programmgesteuert abrufen und analysieren – ganz ohne manuellen Aufwand. Genau das ermöglichen Ihnen CJA APIs!

Stellen Sie sich APIs als Boten vor – sie übermitteln Ihre Anfragen an die Server von Adobe und liefern die Ergebnisse in einem übersichtlichen Paket zurück.

Erfolgreich starten

Bevor Sie Ihren ersten API-Aufruf durchführen, müssen Sie den richtigen Zugriff und die entsprechenden Berechtigungen einrichten. Stellen Sie zunächst sicher, dass Sie als Entwickler für Ihre Organisation hinzugefügt wurden. Prüfen Sie dann, ob Sie Zugriff auf die Produktprofile mit den erforderlichen Berechtigungen haben.

Schritt 1: Ihren API-Schlüssel erhalten
  1. Melden Sie sich bei der Adobe Developer Console an.
  2. Neues Projekt erstellen und die Customer Journey Analytics API zu Ihrem Projekt hinzufügen sowie die benötigten Produktprofile auswählen.
  3. Klicken Sie auf Zu Projekt hinzufügen und fügen Sie auch die Adobe Experience Platform API dem Projekt hinzu.
  4. Nach Abschluss der Einrichtung finden Sie alle erforderlichen Informationen im Anmeldedaten-Tab in der linken Navigation.

Hier sind die drei wichtigsten Header-Parameter, die für alle API-Anfragen erforderlich sind:

Speichern Sie diese Anmeldedaten unbedingt ab – sie sind Ihr Schlüssel, um das volle Potenzial der API zu nutzen! Ausführliche Schritt-für-Schritt-Anleitungen finden Sie im Abschnitt Erste Schritte der CJA API.

Schritt 2: Testen Sie Ihre Einrichtung

Eine hervorragende Möglichkeit, APIs zu testen, ohne Code zu schreiben, ist die Nutzung des leistungsstarken und benutzerfreundlichen Tools Postman. Nach dem Start der Anwendung können Sie Ihre API-Anmeldedaten ganz einfach importieren und mit einfachen GET-Anfragen experimentieren, um zu überprüfen, ob Ihre Verbindung und Authentifizierung ordnungsgemäß funktionieren. Es empfiehlt sich, Ihre API-Tests mit GET-Anfragen zu beginnen, da diese als sicherer und nicht destruktiv gelten. Sie rufen lediglich Daten vom Server ab, ohne Änderungen vorzunehmen. Im Gegensatz dazu können andere HTTP-Methoden wie POST-, PUT- oder DELETE-Anfragen Daten auf dem Server verändern oder löschen und sollten daher mit besonderer Vorsicht getestet werden.

Ihre erste API-Abfrage

Fangen wir mit etwas Einfachem an: Rufen Sie eine Liste der verfügbaren Datenansichten in Ihrem CJA-Konto ab.

Beispiel: Datenansichten auflisten

Endpunkt:
GET https://cja.adobe.io/data/dataviews

Header:

x-api-key: {API_KEY}

x-gw-ims-org-id: {IMS_ORG_ID}

Autorisierung: Bearer {AUTHORIZATION_TOKEN}

CURL-Anfrage:

curl -X GET "https://cja.adobe.io/data/dataviewsexpansion=name%2Cowner%2Corganization%2Cdescription"\

-H "x-api-key: {API_KEY}" \

-H "x-gw-ims-org-id: {IMS_ORG_ID}" \

-H "Autorisierung: Bearer {AUTHORIZATION_TOKEN}"

Sie können diese Anfragen auch direkt in der CJA API-Endpunktdokumentation mit der Try It-Funktion ausprobieren. Hier finden Sie den Link, um die oben genannte Anfrage zu testen.

Klicken Sie einfach auf den CTA Try It und geben Sie alle Pflicht-Parameter ein, in diesem Fall die Header-Parameter, die wir besprochen haben, und klicken Sie auf Send.

Sie können auch zusätzliche Parameter hinzufügen, um Ihre Anfrage anzupassen. Eine Liste der verfügbaren Parameter finden Sie im Abschnitt Abfrage-Parameter zu jeder API-Anfrage in der CJA API Dokumentation.

Hier sind die wichtigsten HTTP-Status-Codes, denen Sie bei der Arbeit mit APIs begegnen:

Diese Status-Codes zeigen Entwicklerinnen und Entwicklern genau, was während einer API-Anfrage passiert ist, und erleichtern so die Fehlerbehebung.

NOTE
Wenn Sie die Funktion Try It verwenden, stellen Sie sicher, dass das Zugriffstoken im Feld Autorisierung mit „Bearer“ beginnt. Wenn dieser Präfix fehlt oder falsch geschrieben ist, führt das zu einem 401-Fehler.

Tipps für API-Einsteigerinnen und -Einsteiger

  1. Zugriff prüfen: Stellen Sie sicher, dass Sie über die richtigen Berechtigungsstufen verfügen und den passenden Produktprofilen zugeordnet sind. Fehlende Zugriffsrechte sind die häufigste Ursache für nicht erfolgreiche API-Anfragen
  2. Testen, testen, testen: Nutzen Sie die Try It-Funktion in der API-Endpunkt-Dokumentation oder in Postman, um Anfragen auszuprobieren, bevor Sie Code schreiben.
  3. Klein anfangen: Starten Sie mit einfachen GET-Anfragen und steigern Sie sich zu POST-Abfragen.
  4. Dokumentation nutzen: Die CJA API-Dokumentation von Adobe ist eine unverzichtbare Ressource. Prüfen Sie regelmäßig auf Updates, da ältere Konfigurationen nach größeren Aktualisierungen möglicherweise nicht mehr wie erwartet funktionieren.
  5. Fragen stellen: Wenden Sie sich bei Fragen gerne an die Experience League Adobe Analytics Community.

Der Einstieg in die Adobe CJA APIs wirkt anfangs vielleicht herausfordernd, aber mit etwas Übung automatisieren Sie schon bald Ihre Workflows und gewinnen wertvolle Einblicke. Gehen Sie den ersten Schritt: Melden Sie sich an, holen Sie Ihre Zugangsdaten und testen Sie einen einfachen API-Aufruf. Ihr API-Abenteuer beginnt jetzt!

style
article-content-section
5 Minuten
style
article-header-section