Dieser Artikel behandelt Adobe Customer Journey Analytics (CJA)-APIs und bietet detaillierte Informationen zur Datenextraktion, zu benutzerdefinierten Lösungen und zur Integration von Drittanbietern. Enthalten sind die Zugangseinrichtung, API-Schlüssel, Tests mit Postman, ein Beispiel für einen schrittweisen API-Aufruf und Tipps für Erstbenutzerinnen und -benutzer.

Haben Sie noch keine Erfahrung mit APIs und möchten wissen, wie Ihnen Adobe Customer Journey Analytics (CJA)-APIs helfen können? Dann sind Sie hier richtig! In dieser Anleitung speziell für Anfängerinnen und Anfänger erläutern wir die Grundlagen, erklären spezielle Begriffe und helfen Ihnen, Ihre ersten Schritte in die spannende Welt der CJA-APIs zu unternehmen.

Stellen Sie sich vor, Sie hätten die Möglichkeit, ohne manuellen Aufwand programmgesteuert auf Ihre CJA-Daten zuzugreifen und sie zu analysieren. Genau das können Sie mit CJA-APIs tun.

• Effizientes Extrahieren von Daten: Vereinfachen Sie die Datenextraktion mithilfe von API-Aufrufen.
• Erstellen benutzerdefinierter Lösungen: Entwerfen und implementieren Sie automatisierte Reporting-Pipelines, die auf Ihre spezifischen Geschäftsanforderungen zugeschnitten sind.
• Nahtlose Verbindung: Ermöglichen Sie durch zuverlässige Integrationen einen reibungslosen Datenfluss zwischen CJA und Anwendungen von Drittanbietern.

Stellen Sie sich APIs als Boten vor: Sie übertragen Ihre Anfragen an die Adobe-Server und bringen die Ergebnisse in einem übersichtlichen Paket zurück.

Vorbereitung.

Bevor Sie Ihren ersten API-Aufruf ausführen, müssen Sie die entsprechenden Zugriffsberechtigungen einrichten. Stellen Sie zunächst sicher, dass Sie als Entwicklerin bzw. Entwickler Ihres Unternehmens hinzugefügt wurden. Überprüfen Sie dann, ob Sie Zugriff auf die Produktprofile mit den erforderlichen Berechtigungen haben.

Schritt 1: API-Schlüssel abrufen.

1. Melden Sie sich bei Adobe Developer Console an.
2. Erstellen Sie ein neues Projekt und fügen Sie ihm die Customer Journey Analytics API hinzu. Wählen Sie die erforderlichen Produktprofile aus.
3. Klicken Sie auf Add to Project (Zum Projekt hinzufügen) und fügen Sie Adobe Experience Platform API auch zum Projekt hinzu.
4. Nachdem die Einrichtung abgeschlossen ist, können Sie alle erforderlichen Informationen auf der Registerkarte Credentials (Anmeldedaten) in der linken Leiste abrufen.

Im Folgenden finden Sie die drei wichtigsten Header-Parameter, die für alle API-Anfragen erforderlich sind.

• Zugriffs-Token: Dadurch wird sichergestellt, dass nur autorisierte Benutzende auf die Daten zugreifen können. Ein Zugriffs-Token wird erstellt, indem Sie auf den im Screenshot hervorgehobenen Button Generate access token (Zugriffs-Token generieren) klicken. In der API-Anfrage wird das Token als Authorization-Parameter bezeichnet.
• Client-ID: Wird in der API-Anfrage auch als API-Schlüssel x-api-key bezeichnet.
• Organization ID: Wird in der API-Anfrage als x-gw-ims-org-id bezeichnet.

Vergessen Sie nicht diese Anmeldedaten zu speichern – sie sind Ihr Schlüssel zum enormen Potenzial der APIs. Detailliertere schrittweise Anweisungen finden Sie im Abschnitt Erste Schritte der CJA-API.

Schritt 2: Einrichtung testen.

Eine hervorragende Methode, APIs zu testen, ohne Code schreiben zu müssen, ist die Verwendung des leistungsstarken und benutzerfreundlichen Tools Postman. Nach dem Start der Anwendung können Sie Ihre API-Anmeldedaten einfach importieren und mit simplen GET-Anfragen experimentieren, um zu überprüfen, ob Ihre Verbindung und Authentifizierung ordnungsgemäß funktionieren. Es ist empfehlenswert, Ihre API-Tests mit GET-Anfragen zu beginnen, da diese als sicherer und zerstörungsfrei gelten, da sie nur Daten vom Server abrufen, ohne Änderungen vorzunehmen. Im Gegensatz dazu gibt es auch andere HTTP-Methoden wie POST-, PUT- oder DELETE-Anfragen, die Daten auf dem Server ändern oder entfernen können und daher mit mehr Vorsicht getestet werden sollten.

Erster API-Aufruf.

Machen Sie einen einfachen Test: Rufen Sie eine Liste der verfügbaren Datenansichten in Ihrem CJA-Konto ab.

Beispiel: Datenansichten abrufen.

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 "Authorization: Bearer {AUTHORIZATION_TOKEN}"

Sie können diese Anfragen auch in der CJA-API-Endpunkt-Dokumentation testen, indem Sie die Funktion Try it (Ausprobieren) verwenden. Hier finden Sie den Link, um die obige Anfrage auszuprobieren.

Klicken einfach auf den Button Try it und geben Sie alle erforderlichen Parameter ein – in diesem Fall die genannten Header-Parameter – und wählen Sie Send (Senden).

Sie können auch zusätzliche Parameter hinzufügen, um Ihre Anfrage anzupassen. Eine Liste der verfügbaren Parameter finden Sie im Abschnitt Query Parameters (Abfrageparameter) für jede API-Anfrage in der CJA-API-Dokumentation.

Im Folgenden finden Sie die wichtigsten HTTP-Antwort-Codes bei der Verwendung von APIs:

• 200: Erfolgreich – Der Server hat die Anfrage erfolgreich verarbeitet und Daten zurückgegeben.
• 404: Nicht gefunden – Der Server hat die angeforderte Ressource nicht gefunden.
• 500: Interner Server-Fehler – Es ist ein Server-seitiger Fehler aufgetreten.

Durch diese Status-Codes erfahren Entwicklerinnen und Entwicklern genau, was während einer API-Anfrage passiert ist, wodurch die Fehlerbehebung erleichtert wird.

Tipps für API-Erstbenutzende.

1. Überprüfen Sie Ihre Berechtigungen: Stellen Sie sicher, dass Sie über die erforderlichen Berechtigungen verfügen und zu den richtigen Produktprofilen hinzugefügt wurden. Eine unzureichende Berechtigung ist der häufigste Grund für fehlgeschlagene API-Anfragen.
2. Testen, Testen, Testen: Verwenden Sie die Funktion Try it in der API-Endpunkt-Dokumentation oder in Postman, um mit Anfragen zu experimentieren, bevor Sie Code schreiben.
3. Beginnen Sie klein: Beginnen Sie mit einfachen GET-Anfragen und arbeiten Sie sich vor bis zu POST-Abfragen.
4. Verwenden Sie die Dokumentation: Die CJA-API-Dokumentation von Adobe hilft Ihnen. Suchen sie regelmäßig nach Updates, da ältere Konfigurationen nach umfangreicheren Updates möglicherweise nicht mehr wie erwartet funktionieren.
5. Stellen Sie Fragen: Wenden Sie sich an die Experience League Adobe Analytics Community, wenn Sie Hilfe benötigen.

Die ersten Schritte mit Adobe CJA-APIs mögen zunächst schwierig erscheinen. Doch mit ein wenig Übung werden Sie schon bald in der Lage sein, Workflows zu automatisieren und Erkenntnisse zu gewinnen. Machen Sie also den ersten Schritt: Melden Sie sich an, holen Sie sich Ihre Anmeldedaten und probieren Sie einen einfachen API-Aufruf aus. Ihr API-Abenteuer erwartet Sie!