Authentifizieren von und Zugreifen auf die Reactor-API

Um mithilfe der Reactor-API Tags-Erweiterungen zu erstellen und zu verwalten, muss jede Anfrage die folgenden Authentifizierungs-Header enthalten:

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

In diesem Handbuch wird beschrieben, wie Sie die Adobe-Entwicklerkonsole verwenden, um die Werte für die einzelnen Header zu erfassen, damit Sie Aufrufe an die Reactor-API durchführen können.

Erhalten von Entwicklerzugriff auf Adobe Experience Platform gain-developer-access

Bevor Sie Authentifizierungswerte für die Reactor-API generieren können, müssen Sie über Entwicklerzugriff auf Experience Platform verfügen. Um Entwicklerzugriff zu erhalten, führen Sie die ersten Schritte im Authentifizierungs-Tutorial für Experience Platform aus. Nachdem Sie den Schritt Benutzerzugriff erhalten abgeschlossen haben, kehren Sie zu diesem Tutorial zurück, um die für die Reactor-API spezifischen Anmeldeinformationen zu generieren.

Generieren von Zugriffsanmeldedaten generate-access-credentials

Mithilfe der Adobe-Entwicklerkonsole müssen Sie die folgenden drei Zugriffsanmeldedaten generieren:

  • {ORG_ID}
  • {API_KEY}
  • {ACCESS_TOKEN}

Die ID ({ORG_ID}) Ihres Unternehmens und der API-Schlüssel ({API_KEY}) können, wenn sie einmal generiert worden sind, in zukünftigen API-Aufrufen wiederverwendet werden. Ihr Zugriffs-Token ({ACCESS_TOKEN}) ist jedoch temporär und muss alle 24 Stunden neu generiert werden.

Die Schritte zum Generieren dieser Werte werden im Folgenden detailliert beschrieben.

Einmalige Einrichtung one-time-setup

Wechseln Sie zur Adobe-Entwicklerkonsole und melden Sie sich mit Ihrer Adobe ID an. Führen Sie anschließend die im Tutorial Erstellen eines leeren Projekts in der Dokumentation zur Entwicklerkonsole beschriebenen Schritte aus.

Nachdem Sie ein Projekt erstellt haben, wählen Sie API hinzufügen im Bildschirm Projektübersicht aus.

Der Bildschirm API hinzufügen wird angezeigt. Wählen Sie Experience Platform Launch-API aus der Liste der verfügbaren APIs aus, bevor Sie auf Weiter klicken.

Wählen Sie als Nächstes den Authentifizierungstyp aus, um Zugriffstoken zu generieren und auf die Experience Platform-API zuzugreifen.

IMPORTANT
Wählen Sie die OAuth Server-zu-Server-Methode aus, da dies in Zukunft die einzige unterstützte Methode ist. Die Methode Service-Konto (JWT ist veraltet. Während Integrationen, die die JWT-Authentifizierungsmethode verwenden, bis zum 1. Januar 2025 weiterhin funktionieren, empfiehlt Adobe dringend, vorhandene Integrationen vor diesem Datum zu der neuen OAuth-Server-zu-Server-Methode zu migrieren. Weitere Informationen finden Sie im Abschnitt [Veraltet]{class="badge negative"}Generieren eines JSON Web Token (JWT) im Tutorial zur Platform-API-Authentifizierung.

Klicken Sie auf Weiter, um fortzufahren.

Wählen Sie die OAuth Server-zu-Server-Authentifizierungsmethode aus.

Im nächsten Bildschirm werden Sie aufgefordert, ein oder mehrere Produktprofile auszuwählen, die mit der API-Integration verknüpft werden sollen.

NOTE
Produktprofile werden von Ihrem Unternehmen über die Adobe Admin Console verwaltet und enthalten bestimmte Berechtigungssätze für granulare Funktionen. Produktprofile und ihre Berechtigungen können nur von Benutzern mit Administratorrechten innerhalb Ihres Unternehmens verwaltet werden. Wenn Sie sich nicht sicher sind, welche Produktprofile für die API ausgewählt werden sollen, wenden Sie sich an Ihren Administrator.

Wählen Sie die gewünschten Produktprofile aus der Liste aus und klicken Sie dann auf Konfigurierte API speichern, um die API-Registrierung abzuschließen.

Sammeln von Anmeldeinformationen gather-credentials

Nachdem die API zum Projekt hinzugefügt wurde, werden auf der Seite Experience Platform-API für das Projekt die folgenden Anmeldeinformationen angezeigt, die für alle Aufrufe an Experience Platform-APIs erforderlich sind:

  • {API_KEY} (Client ID)
  • {ORG_ID} (Organization ID)

Integrationsinformationen nach dem Hinzufügen einer API in Developer Console.

Erstellen eines Zugriffs-Tokens generate-access-token

Der nächste Schritt besteht darin, eine {ACCESS_TOKEN} für die Verwendung in Platform-API-Aufrufen zu generieren. Im Gegensatz zu den Werten für {API_KEY} und {ORG_ID} muss alle 24 Stunden ein neues Token generiert werden, um Platform-APIs weiterhin verwenden zu können.

TIP
Diese Token laufen nach 24 Stunden ab. Wenn Sie diese Integration für ein Programm verwenden, empfiehlt es sich, Ihr Träger-Token programmgesteuert aus Ihrem Programm abzurufen.

Je nach Anwendungsfall haben Sie zwei Möglichkeiten, Ihre Zugriffs-Token zu generieren:

Manuelles Generieren von Zugriffs-Token manual

Um ein neues {ACCESS_TOKEN} manuell zu generieren, navigieren Sie zu Anmeldeinformationen > OAuth Server-zu-Server und wählen Sie Zugriffstoken generieren aus, wie unten dargestellt.

Bildschirmaufzeichnung, wie und Zugriffstoken in der Developer Console-Benutzeroberfläche generiert werden.

Es wird ein neues Zugriffs-Token generiert und eine Schaltfläche zum Kopieren des Tokens in die Zwischenablage bereitgestellt. Dieser Wert wird für den erforderlichen Autorisierungs-Header verwendet und muss im Format Bearer {ACCESS_TOKEN} angegeben werden.

Token-Generierung automatisieren auto-token

Sie können auch eine Postman-Umgebung und -Sammlung verwenden, um Zugriffs-Token zu generieren. Weitere Informationen finden Sie im Abschnitt über Verwendung von Postman zum Authentifizieren und Testen von APIAufrufen im Experience Platform-API-Authentifizierungshandbuch.

API-Testanmeldeinformationen test-api-credentials

Durch Befolgen der Schritte in diesem Tutorial sollten Sie über gültige Werte für {ORG_ID}, {API_KEY} und {ACCESS_TOKEN} verfügen. Sie können diese Werte jetzt testen, indem Sie sie in einer einfachen cURL-Anfrage an die Reactor-API verwenden.

Beginnen Sie mit dem Versuch, einen API-Aufruf durchzuführen, um alle Unternehmen aufzulisten.

NOTE
Möglicherweise haben Sie in Ihrer Organisation keine Unternehmen. In diesem Fall lautet die Antwort HTTP-Status 404 (Nicht gefunden). Solange kein 403-Fehler (Verboten) ausgegeben wird, sind Ihre Anmeldedaten gültig und funktionieren.

Sobald Sie sich vergewissert haben, dass Ihre Zugriffsanmeldedaten funktionieren, lesen Sie die weitere API-Referenzdokumentation, um mehr über die vielen Funktionen der API zu erfahren.

Lesen von Beispiel-API-Aufrufen read-sample-api-calls

Jedes Endpunkt-Handbuch enthält Beispiel-API-Aufrufe, um zu demonstrieren, wie Sie Ihre Anfragen formatieren. 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 Abschnitt zum Lesen von BeispielAPI-Aufrufen in den Ersten Schritten für Platform-APIs.

Nächste Schritte next-steps

Nachdem Sie nun wissen, welche Kopfzeilen zu verwenden sind, können Sie damit beginnen, die Reactor-API aufzurufen. Wählen Sie zunächst eines der Handbücher zu den Endpunkten aus:

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743