Authentifizieren und Zugreifen auf Experience Platform-APIs

Dieses Dokument enthält eine schrittweise Anleitung zum Erhalten von Zugriff auf ein Adobe Experience Platform-Entwicklerkonto, um Aufrufe an Experience Platform-APIs durchzuführen. Am Ende dieses Tutorials haben Sie die folgenden Anmeldeinformationen generiert oder gesammelt, die als Kopfzeilen in allen Platform-API-Aufrufen erforderlich sind:

Um die Sicherheit Ihrer Programme und Benutzer zu gewährleisten, müssen alle Anfragen an Experience Platform-APIs mithilfe von Standards wie OAuth authentifiziert und autorisiert werden.

In diesem Tutorial wird beschrieben, wie Sie die erforderlichen Anmeldeinformationen sammeln, um Platform-API-Aufrufe zu authentifizieren, wie im folgenden Flussdiagramm beschrieben. Die meisten erforderlichen Anmeldeinformationen können bei der einmaligen Ersteinrichtung erfasst werden. Das Zugriffs-Token muss jedoch alle 24 Stunden aktualisiert werden.

Voraussetzungen prerequisites

Um Experience Platform-APIs erfolgreich aufrufen zu können, benötigen Sie Folgendes:

Sie müssen auch über eine Adobe ID verfügen, um dieses Tutorial abzuschließen. Wenn Sie keine Adobe ID haben, können Sie wie folgt eine erstellen:

Erhalten von Entwicklungs- und Benutzerzugriff für Experience Platform gain-developer-user-access

Bevor Sie Integrationen in Adobe Developer Console erstellen können, muss Ihr Konto über Entwickler- und Benutzerberechtigungen für ein Experience Platform-Produktprofil in Adobe Admin Console verfügen.

Erhalten von Entwicklerzugriff gain-developer-access

Wenden Sie sich an einen Entwicklungs-Administrator in Ihrer Admin Console, um Sie als Entwicklerin bzw. Entwickler zu einem Experience Platform-Produktprofil hinzuzufügen. Admin Console Spezifische Anweisungen zum Verwalten des Entwicklerzugriffs Produktprofile finden Sie in der Dokumentation zur.

Sobald Sie als Entwickler zugewiesen sind, können Sie mit der Erstellung von Integrationen in Adobe Developer Console beginnen. Diese Integrationen sind eine Pipeline von externen Apps und Services zu Adobe-APIs.

Erhalten von Benutzerzugriff gain-user-access

Ihr Admin Console-Administrator muss Sie auch als Benutzerin bzw. Benutzer demselben Produktprofil hinzufügen. Beim Benutzerzugriff können Sie in der Benutzeroberfläche das Ergebnis der von Ihnen durchgeführten API-Vorgänge sehen.

Weitere Informationen finden Sie Handbuch unter „Verwalten von BenutzergruppenAdmin Console".

API-Schlüssel (Client-ID) und Organisations-ID generieren generate-credentials

Nachdem Sie über Admin Console Entwickler- und Benutzerzugriff auf Platform erhalten haben, besteht der nächste Schritt darin, Ihre {ORG_ID}- und {API_KEY}-Anmeldeinformationen in Adobe Developer Console zu generieren. Diese Anmeldeinformationen müssen nur einmal generiert werden und können in zukünftigen Platform-API-Aufrufen wiederverwendet werden.

Experience Platform zu einem Projekt hinzufügen add-platform-to-project

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

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

Der Bildschirm API hinzufügen wird angezeigt. Wählen Sie das Produktsymbol für Adobe Experience Platform und dann Experience Platform API aus, bevor Sie Weiter auswählen.

Wählen Sie den Authentifizierungstyp OAuth Server-zu-Server aus select-oauth-server-to-server

Wählen Sie als Nächstes den OAuth Server-zu-Server-Authentifizierungstyp aus, um Zugriffstoken zu generieren und auf die Experience Platform-API zuzugreifen. Geben Sie Ihrer Berechtigung einen aussagekräftigen Namen im Textfeld Berechtigungsname, bevor Sie auf Weiter klicken.

Auswählen der Produktprofile für Ihre Integration select-product-profiles

Wählen Sie auf dem API konfigurieren die Option AEP-Default-All-Users zusammen mit allen zusätzlichen Produktprofilen aus, auf die Sie Zugriff erhalten möchten.

Wählen Sie Konfigurierte API speichern wenn Sie bereit sind.

Eine exemplarische Vorgehensweise der oben beschriebenen Schritte zum Einrichten einer Integration mit der Experience Platform-API ist ebenfalls im folgenden Video-Tutorial verfügbar:

Sammeln von Anmeldeinformationen gather-credentials

Nachdem die API zum Projekt hinzugefügt wurde, zeigt die Seite OAuth Server-zu-Server für das Projekt die folgenden Anmeldeinformationen an, die für alle Aufrufe an Experience Platform-APIs erforderlich sind:

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. Wählen Sie Zugriffs-Token generieren aus, wodurch Ihr Zugriffs-Token generiert wird, wie unten dargestellt.

Authentifizierungsdaten direkt in der API-Referenzdokumentation erstellen und abrufen get-credentials-functionality

Ab der Experience Platform-Version vom November 2024 können Sie Anmeldedaten für die Verwendung der Experience Platform-APIs direkt von den API-Referenzseiten erhalten, ohne zu Developer Console wechseln zu müssen. Sehen Sie sich das folgende Beispiel auf der Seite Flow Service-API - Ziele“.

Um Anmeldeinformationen zum Aufrufen von Platform-APIs zu erhalten, navigieren Sie zu einer beliebigen Experience Platform-API-Referenzseite und wählen Anmelden oben auf der Seite aus. Melden Sie sich mit Ihrem Persönlichen Konto oder Firmen- oder Schulkonto an.

Wählen Sie nach der Anmeldung Neue Anmeldedaten erstellen aus, um einen neuen Satz von Anmeldedaten für den Zugriff auf Platform-APIs zu erstellen.

Verwenden Sie als Nächstes die Dropdown-Auswahl, um das Fenster mit den Anmeldedaten zu öffnen, ein Zugriffstoken zu generieren und Ihren API-Schlüssel und Ihre Organisations-ID abzurufen. Kopieren Sie die Anmeldeinformationen in die Probieren Sie es aus Blöcke auf den API-Referenzseiten, um mit der Arbeit mit Platform-APIs zu beginnen.

[Veraltet]{class="badge informative"} Generieren eines JSON Web Token (JWT) jwt

curl -X POST https://ims-na1.adobelogin.com/ims/exchange/jwt \
  -H 'Content-Type: multipart/form-data' \
  -F 'client_id={API_KEY}' \
  -F 'client_secret={SECRET}' \
  -F 'jwt_token={JWT}'

{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}

Testen von Zugriffsberechtigungen test-credentials

Nachdem Sie alle drei erforderlichen Anmeldeinformationen - Zugriffstoken, API-Schlüssel und Organisations-ID - erfasst haben, können Sie versuchen, den folgenden API-Aufruf durchzuführen. Dieser Aufruf listet alle standardmäßigen Experience Data Model (XDM)-Klassen auf, die für Ihre Organisation verfügbar sind. Importieren und Ausführen des Aufrufs in Postman.

Anfrage

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: {{ORG_ID}}'

Antwort

Wenn Ihre Antwort der unten gezeigten ähnelt, sind Ihre Anmeldedaten gültig und funktionieren. (Diese Antwort wurde aus Platzgründen abgeschnitten.)

{
  "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"
    }
  ]
}

Abrufen der erforderlichen attributbasierten Zugriffssteuerungsberechtigungen get-abac-permissions

Um auf mehrere Ressourcen in Experience Platform zuzugreifen oder sie zu ändern, benötigen Sie die entsprechenden Zugriffssteuerungsberechtigungen. Systemadministratoren können Ihnen die erforderlichen Berechtigungen“. Weitere Informationen finden Sie im Abschnitt Verwalten von API-Anmeldeinformationen für eine Rolle.

Detaillierte Informationen dazu, wie ein Systemadministrator bzw. eine Systemadministratorin die erforderlichen Berechtigungen für den Zugriff auf Platform-Ressourcen über die API gewähren kann, finden Sie im folgenden Video-Tutorial:

Verwenden von Postman zum Authentifizieren und Testen von API-Aufrufen use-postman

Postman ist ein beliebtes Tool, mit dem Entwickler RESTful-APIs untersuchen und testen können. Sie können Experience Platform Postman-Sammlungen und -Umgebungen verwenden, um Ihre Arbeit mit Experience Platform-APIs zu beschleunigen. Lesen Sie mehr über Verwendung von Postman im Experience Platform und die ersten Schritte mit Sammlungen und Umgebungen.

Detaillierte Informationen zur Verwendung von Postman mit Experience Platform-Sammlungen und Umgebungen finden Sie in den folgenden Video-Tutorials:

Laden Sie eine Postman-Umgebung herunter und importieren Sie sie, um sie mit Experience Platform-APIs zu verwenden

Verwenden Sie eine Postman-Sammlung, um Zugriffstoken zu generieren

Laden Sie die Postman-Sammlung für den Identity ManagementService herunter und sehen Sie sich das folgende Video an, um zu erfahren, wie Sie Zugriffs-Token generieren.

Herunterladen von Experience Platform-API-Postman-Sammlungen und Interaktion mit den APIs

Systemadministratoren: Gewähren von Entwickler- und API-Zugriffskontrolle mit Experience Platform-Berechtigungen grant-developer-and-api-access-control

Bevor Sie Integrationen in Adobe Developer Console erstellen können, muss Ihr Konto über Entwickler- und Benutzerberechtigungen für ein Experience Platform-Produktprofil verfügen.

Hinzufügen von Entwicklern zum Produktprofil add-developers-to-product-profile

Navigieren Sie zur Admin Console 🔗 und melden Sie sich mit Ihrer Adobe ID an.

Wählen in Navigationsleiste „Produkte“ und dann Adobe Experience Platform aus der Liste der Produkte aus.

Wählen Sie auf der Produktprofile die Option AEP-Default-All-Users aus. Alternativ können Sie über die Suchleiste nach dem Produktprofil suchen, indem Sie den Namen eingeben.

Wählen Sie die Registerkarte Entwickler und dann Entwickler hinzufügen aus.

Das Entwickler hinzufügen wird angezeigt. Geben Sie die E--Adresse oder den Benutzernamen des Entwicklers. Eine gültige E-Mail oder Benutzername zeigt die Details für den Entwickler an. Wählen Sie Speichern aus.

Der Entwickler wurde erfolgreich hinzugefügt und wird auf der Registerkarte Entwickler angezeigt.

Zuweisen von API-Anmeldeinformationen zu einer Rolle

Um Experience Platform-APIs verwenden und Vorgänge damit durchführen zu können, muss ein Systemadministrator die API-Anmeldeinformationen zusätzlich zu den einer Rolle zugewiesenen Berechtigungen hinzufügen. Weitere Informationen finden Sie im Abschnitt Verwalten von API-Anmeldeinformationen für eine Rolle.

Eine exemplarische Vorgehensweise der oben beschriebenen Schritte zum Hinzufügen von Entwicklern zu Produktprofilen und zum Zuweisen von APIs zu Rollen ist ebenfalls im folgenden Video-Tutorial verfügbar:

Zusätzliche Ressourcen additional-resources

Weitere Informationen zu den ersten Schritten mit Experience Platform-APIs finden Sie in den unten verlinkten zusätzlichen Ressourcen

Nächste Schritte next-steps

Durch das Lesen dieses Dokuments haben Sie Ihre Zugriffsberechtigungen für Platform-APIs gesammelt und erfolgreich getestet. Sie können jetzt den Beispiel-API-Aufrufen folgen, die in der () bereitgestellt.

Zusätzlich zu den Authentifizierungswerten, die Sie in diesem Tutorial gesammelt haben, benötigen viele Platform-APIs auch eine gültige {SANDBOX_NAME} als Kopfzeile. Weiterführende Informationen dazu finden Sie unter Sandbox-Übersicht.