Authentifizieren von und Zugreifen auf die Reactor-API

Damit die Reactor-API zum Erstellen und Verwalten von Tags-Erweiterungen verwendet werden kann, muss jede Anfrage die folgenden Authentifizierungskopfzeilen 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. Kehren Sie nach Abschluss des Schritts Benutzerzugriff erlangen zu diesem Tutorial zurück, um die spezifischen Anmeldeinformationen für die Reactor-API zu generieren.

Generieren von Zugriffsberechtigungen generate-access-credentials

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

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

Die ID ({ORG_ID}) und der API-Schlüssel ({API_KEY}) Ihres Unternehmens können in zukünftigen API-Aufrufen wiederverwendet werden, nachdem sie ursprünglich generiert wurden. 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, bevor Sie Weiter auswählen.

Wählen Sie anschließend den Authentifizierungstyp aus, um Zugriffstoken zu generieren und auf die Experience Platform-API zuzugreifen.

IMPORTANT
Wählen Sie die Methode OAuth Server-zu-Server aus, da dies künftig die einzige unterstützte Methode sein wird. Die Methode Dienstkonto (JWT) wird nicht mehr unterstützt. Während Integrationen, die die JWT-Authentifizierungsmethode verwenden, bis zum 1. Januar 2025 weiterhin funktionieren, empfiehlt Adobe dringend, vorhandene Integrationen vor diesem Datum auf die neue OAuth Server-zu-Server-Methode zu migrieren. Weitere Informationen finden Sie im Abschnitt [Veraltet]{class="badge informative"} .{type=negative}Generieren Sie ein 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.

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, zeigt die Seite Experience Platform-API für das Projekt die folgenden Anmeldeinformationen an, die für alle Aufrufe an Experience Platform-APIs erforderlich sind:

  • {API_KEY} (Client-ID)
  • {ORG_ID} (Organisations-ID)

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

Zugriffstoken generieren generate-access-token

Der nächste Schritt besteht darin, eine {ACCESS_TOKEN} -Berechtigung 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 weiterhin Platform-APIs 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 manuell einen neuen {ACCESS_TOKEN} zu generieren, navigieren Sie zu Anmeldeinformationen > OAuth Server-to-Server und wählen Sie Zugriffstoken generieren, wie unten dargestellt.

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

Es wird ein neues Zugriffs-Token generiert und eine Schaltfläche zum Kopieren des Tokens in die Zwischenablage bereitgestellt. Dieser Wert wird für die erforderliche Autorisierungskopfzeile 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 Zugriffstoken zu generieren. Weitere Informationen finden Sie im Abschnitt über die Verwendung von Postman zum Authentifizieren und Testen von API-Aufrufen🔗 im Experience Platform API-Authentifizierungshandbuch.

API-Anmeldeinformationen testen 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 Zugangsdaten gültig und funktionieren.

Sobald Sie sich vergewissert haben, dass Ihre Zugriffsberechtigungen 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 Endpunkthandbuch enthält Beispiel-API-Aufrufe, die zeigen, 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 im Abschnitt zu Lesen von Beispiel-API-Aufrufen im Erste-Schritte-Handbuch für Platform-APIs.

Nächste Schritte next-steps

Nachdem Sie nun wissen, welche Header verwendet werden sollen, können Sie mit Aufrufen an die Reactor-API beginnen. Wählen Sie eine der Endpunktleitfäden für die ersten Schritte aus:

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