Authentifizieren und Zugreifen auf Experience Platform-APIs

Dieses Dokument bietet eine schrittweise Anleitung zum Zugriff auf ein Adobe Experience Platform-Entwicklerkonto, um Experience Platform-APIs aufrufen zu können. Am Ende dieses Tutorials haben Sie die folgenden Anmeldeinformationen generiert oder erfasst, die als Kopfzeilen in allen Platform-API-Aufrufen erforderlich sind:

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

In diesem Tutorial wird beschrieben, wie Sie die erforderlichen Anmeldeinformationen zum Authentifizieren von Platform-API-Aufrufen erfassen, wie im unten stehenden Flussdiagramm beschrieben. Sie können die meisten erforderlichen Anmeldeinformationen bei der ersten einmaligen Einrichtung erfassen. Das Zugriffstoken muss jedoch alle 24 Stunden aktualisiert werden.

Voraussetzungen prerequisites

Um Experience Platform-APIs erfolgreich aufrufen zu können, müssen Sie über Folgendes verfügen:

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:

Entwickler- und Benutzerzugriff für Experience Platform erlangen gain-developer-user-access

Vor der Erstellung von Integrationen in Adobe Developer Console muss Ihr Konto über Entwickler- und Benutzerberechtigungen für ein Experience Platform-Produktprofil in Adobe Admin Console verfügen.

Entwicklerzugriff erlangen gain-developer-access

Wenden Sie sich an einen Admin Console -Administrator in Ihrer Organisation, um Sie als Entwickler einem Experience Platform-Produktprofil mit dem Admin Console hinzuzufügen. Spezifische Anweisungen zum Verwalten des Entwicklerzugriffs für Produktprofile🔗 finden Sie in der Dokumentation zu Admin Console .

Nachdem Sie als Entwickler zugewiesen wurden, können Sie mit der Erstellung von Integrationen in Adobe Developer Console beginnen. Bei diesen Integrationen handelt es sich um eine Pipeline von externen Apps und Diensten zu Adobe-APIs.

Benutzerzugriff erlangen gain-user-access

Ihr Admin Console -Administrator muss Sie auch als Benutzer demselben Produktprofil hinzufügen. Mit dem Benutzerzugriff können Sie in der Benutzeroberfläche das Ergebnis der von Ihnen ausgeführten API-Vorgänge anzeigen.

Weitere Informationen finden Sie im Handbuch zum Verwalten von Benutzergruppen in Admin Console🔗 .

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

Nachdem Sie Entwickler- und Benutzerzugriff auf Platform über Admin Console erhalten haben, besteht der nächste Schritt darin, Ihre Anmeldedaten für {ORG_ID} und {API_KEY} 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 im Bildschirm Projektübersicht die Option API hinzufügen 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 Authentifizierungstyp OAuth Server-to-Server aus, um Zugriffstoken zu generieren und auf die Experience Platform-API zuzugreifen.

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

Wählen Sie im Bildschirm API konfigurieren die Option AEP-Default-All-Users.

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

Eine exemplarische Vorgehensweise zum Einrichten einer Integration mit der Experience Platform-API finden Sie auch im folgenden Video-Tutorial:

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:

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. Wählen Sie "Zugriffs-Token generieren", wie unten dargestellt.

Erstellen und Abrufen von Authentifizierungsberechtigungen direkt in der API-Referenzdokumentation get-credentials-functionality

Ab der Experience Platform-Version November 2024 können Sie Anmeldeinformationen zur Verwendung der Experience Platform-APIs direkt von den API-Referenzseiten erhalten, ohne zu Developer Console wechseln zu müssen. Sehen Sie sich das unten stehende Beispiel auf der Seite Flow Service-API - Zielean.

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

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

Verwenden Sie anschließend 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 Bausteine Probieren Sie es auf den API-Referenzseiten, um mit Platform-APIs zu arbeiten.

[Veraltet]{class="badge negative"} Erstellen eines JSON-Web-Tokens (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
}

Zugriffsberechtigungen testen 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 -Klassen (XDM) auf, die für Ihr Unternehmen verfügbar sind. Importieren Sie den -Aufruf und führen Sie ihn in Postman aus.

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 verschiedene Ressourcen innerhalb von Experience Platform zugreifen oder sie ändern zu können, benötigen Sie die entsprechenden Zugriffssteuerungsberechtigungen. Systemadministratoren können Ihnen die erforderlichen Berechtigungen erteilen.Weitere Informationen finden Sie im Abschnitt über die Verwaltung von API-Anmeldeinformationen für eine Rolle 🔗.

Ausführliche Informationen dazu, wie ein Systemadministrator die erforderlichen Berechtigungen für den Zugriff auf Platform-Ressourcen über die API gewähren kann, finden Sie auch 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 Sammlungen und Umgebungen in Experience Platform Postman verwenden, um die Arbeit mit Experience Platform-APIs zu beschleunigen. Erfahren Sie mehr über die Verwendung von Postman in Experience Platform und die ersten Schritte mit Sammlungen und Umgebungen.

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

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

Verwenden einer Postman-Sammlung zum Generieren von Zugriffstoken

Laden Sie die Identity Management Service Postman-Sammlung herunter und sehen Sie sich das folgende Video an, um zu erfahren, wie Sie Zugriffstoken generieren.

Laden Sie Experience Platform API Postman-Sammlungen herunter und interagieren Sie mit den APIs

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

Vor der Erstellung von Integrationen in Adobe Developer Console muss Ihr Konto über Entwickler- und Benutzerberechtigungen für ein Experience Platform-Produktprofil in Adobe Admin Console verfügen.

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

Wechseln Sie zu Admin Console und melden Sie sich mit Ihrer Adobe ID an.

Wählen Sie Produkte und dann Adobe Experience Platform aus der Produktliste aus.

Wählen Sie auf der Registerkarte Produktprofile die Option AEP-Default-All-Users. 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.

Geben Sie die E-Mail-Adresse oder den Benutzernamen des Entwicklers ein. Eine gültige E-Mail- oder Benutzername zeigt die Entwicklerdetails an. Wählen Sie Speichern aus.

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

Zuweisen der API zu einer Rolle

Ein Systemadministrator kann Rollen in der Experience Platform-Benutzeroberfläche APIs zuweisen.

Wählen Sie Berechtigungen und die Rolle aus, der Sie die API hinzufügen möchten. Wählen Sie die Registerkarte API-Anmeldeinformationen und dann API-Anmeldeinformationen hinzufügen aus.

Registerkarte

Wählen Sie die API aus, die Sie der Rolle hinzufügen möchten, und wählen Sie dann Speichern aus.

Sie werden zur Registerkarte API-Anmeldeinformationen zurückgeleitet, auf der die neu hinzugefügte API aufgeführt ist.

Registerkarte

Zusätzliche Ressourcen additional-resources

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

Nächste Schritte next-steps

Durch Lesen dieses Dokuments haben Sie Ihre Zugangsdaten für Platform-APIs gesammelt und erfolgreich getestet. Sie können nun den Beispiel-API-Aufrufen folgen, die in der gesamten Dokumentation bereitgestellt werden.

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