Erste Schritte mit REST APIs getting-started-with-rest-apis

Übersicht über Adobe Developer adobeio

Adobe Developer ist das Entwickler-Ökosystem und die Community der Adobe. Es enthält APIs für alle Adobe-Produkte.

Dies ist die empfohlene Methode zum Einrichten und Verwenden Adobe APIs.

Voraussetzungen prerequisites

Bevor Sie JWT Authentifizierung konfigurieren können, stellen Sie sicher, dass Sie Zugriff auf die Adobe Developer Console in Adobe Developer haben. Wenden Sie sich an den Admin Ihrer Organisation, um Zugriffsanfragen zu erhalten.

Authentifizierung auth

Gehen Sie wie folgt vor, um JWT (Service Account) Authentifizierung mithilfe von Adobe Developer zu konfigurieren:

1. Melden Sie sich bei der Adobe Developer Console an.
2. Führen Sie die Schritte unter Service-Kontoverbindung aus.
   • Wählen Sie Schritt 2: Hinzufügen einer API zu Ihrem Projekt mithilfe der AuthentifizierungService-Kontos die Option Audience Manager API .
3. Probieren Sie die Verbindung aus, indem Sie Ihren ersten API-Aufruf auf der Grundlage der Anweisungen aus Schritt 3 ausführen.

RBAC-Berechtigungen für technisches Konto

Audience Manager Wenn Ihr Benutzerkonto die Rollenbasierte Zugriffssteuerung verwendet, müssen Sie ein technisches Benutzerkonto für den Audience Manager erstellen und es der RBAC-Gruppe für den Audience Manager hinzufügen, die die API-Aufrufe durchführt.

Gehen Sie wie folgt vor, um ein technisches Benutzerkonto zu erstellen und es einer RBAC-Gruppe hinzuzufügen:

1. Rufen Sie https://aam.adobe.io/v1/users/self GET an. Mit dem Aufruf wird ein technisches Benutzerkonto erstellt, das Sie im Admin Console auf der Users Seite sehen können.

   

2. Audience Manager Melden Sie sich bei Ihrem Benutzerkonto an und Sie der Benutzergruppe,die API-Aufrufe durchführt, das technische Benutzerkonto.

Die Audience Manager REST API entspricht OAuth 2.0 Standards für die Token-Authentifizierung und -Erneuerung. In den folgenden Abschnitten wird beschrieben, wie Sie sich authentifizieren und mit den API arbeiten.

Erstellen eines generischen API requirements

Es wird empfohlen, ein separates technisches Benutzerkonto für die Arbeit mit den Audience Manager APIs zu erstellen. Dies ist ein generisches Konto, das nicht mit einem bestimmten Benutzer in Ihrer Organisation verknüpft ist. Mit API Benutzerkonto können Sie zwei Dinge erreichen:

• Ermitteln Sie, welcher Service die API aufruft (z. B. Aufrufe von Ihren Apps, die unsere API verwenden, oder von anderen Tools, die API Anfragen stellen).
• Ununterbrochener Zugriff auf die APIs. Ein Konto, das mit einer bestimmten Person verknüpft ist, kann gelöscht werden, wenn diese Person Ihr Unternehmen verlässt. Dadurch wird verhindert, dass Sie mit dem verfügbaren API-Code arbeiten. Ein generisches Konto, das nicht an einen bestimmten Mitarbeiter gebunden ist, hilft Ihnen, dieses Problem zu vermeiden.

Angenommen, Sie möchten mit den „Tools für die Massenverwaltung“ viele Segmente gleichzeitig ändern, Beispiel für diesen Kontotyp. Dazu benötigt Ihr Benutzerkonto API Zugriff. Anstatt einem bestimmten Benutzer Berechtigungen hinzuzufügen, erstellen Sie ein unspezifisches, API Benutzerkonto, das über die entsprechenden Anmeldeinformationen, den Schlüssel und das Geheimnis verfügt, um API Aufrufe durchzuführen. Dies ist auch nützlich, wenn Sie Ihre eigenen Anwendungen entwickeln, die die API der Audience Manager verwenden.

Arbeiten Sie mit Ihrem Audience Manager Berater zusammen, um ein generisches, API Benutzerkonto einzurichten.

Workflow zur Passwortauthentifizierung password-authentication-workflow

Passwortauthentifizierung Sicherer Zugriff auf unsere REST API. Die folgenden Schritte beschreiben den Workflow für die Passwortauthentifizierung von einem JSON-Client in Ihrem Browser.

Schritt 1: API anfordern

Wenden Sie sich an Ihren Partner Solutions Manager. Sie erhalten eine API Client-ID und ein Geheimnis. Die ID und das Geheimnis authentifizieren Sie beim API.

Hinweis: Wenn Sie ein Aktualisierungs-Token erhalten möchten, geben Sie dies an, wenn Sie API Zugriff anfordern.

Schritt 2: Token anfordern

Übergeben Sie eine Token-Anfrage mit Ihrem bevorzugten JSON. Beim Erstellen der Anfrage:

• Verwenden Sie eine POST Methode, um https://api.demdex.com/oauth/token aufzurufen.
• Konvertieren Sie Ihre Client-ID und Ihr Client-Geheimnis in eine mit Base-64 verschlüsselte Zeichenfolge. Trennen Sie ID und Geheimnis während des Konvertierungsprozesses mit einem Doppelpunkt. Beispielsweise testId : testSecret die Anmeldeinformationen in dGVzdElkOnRlc3RTZWNyZXQ= konvertiert.
• Übergeben Sie die HTTP headers Authorization:Basic <base-64 clientID:clientSecret> und Content-Type: application/x-www-form-urlencoded . Ihre Kopfzeile könnte zum Beispiel wie folgt aussehen:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Richten Sie den Anfragetext wie folgt ein:
  
  grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>

Schritt 3: Token empfangen

Die JSON-Antwort enthält Ihr Zugriffstoken. Die Antwort sollte wie folgt aussehen:

{
    "access_token": "28fed402-eafd-456c-9341-ac753f25bbbc",
    "token_type": "bearer",
    "refresh_token": "b27122c0-b0c7-4b39-a71b-1547a3b3b88e",
    "expires_in": 21922,
    "scope": "read write"
}

Der expires_in stellt die Anzahl der Sekunden dar, bis das Zugriffstoken abläuft. Verwenden Sie als Best Practice kurze Ablaufzeiten, um die Verfügbarkeit zu begrenzen, wenn das Token jemals verfügbar ist.

Token aktualisieren refresh-token

Aktualisieren Sie Token, um API Zugriff nach Ablauf des ursprünglichen Tokens zu verlängern. Wenn angefordert, enthält die im Kennwort-Workflow JSON Antwort ein Aktualisierungs-Token. Wenn Sie kein Aktualisierungs-Token erhalten, erstellen Sie mithilfe der Kennwortauthentifizierung ein neues.

Sie können auch ein Aktualisierungs-Token verwenden, um ein neues Token zu generieren, bevor das vorhandene Zugriffs-Token abläuft.

Wenn Ihr Zugriffs-Token abgelaufen ist, erhalten Sie eine 401 Status Code und die folgende Kopfzeile in der Antwort:

WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <token>"

Die folgenden Schritte beschreiben den Workflow für die Verwendung eines Aktualisierungstokens zum Erstellen eines neuen Zugriffstokens von einem JSON Client in Ihrem Browser.

Schritt 1: Anfordern des neuen Tokens

Übergeben Sie eine Aktualisierungs-Token-Anfrage mit Ihrem bevorzugten JSON. Beim Erstellen der Anfrage:

• Verwenden Sie eine POST Methode, um https://api.demdex.com/oauth/token aufzurufen.
• Konvertieren Sie Ihre Client-ID und Ihr Client-Geheimnis in eine mit Base-64 verschlüsselte Zeichenfolge. Trennen Sie ID und Geheimnis während des Konvertierungsprozesses mit einem Doppelpunkt. Beispielsweise testId : testSecret die Anmeldeinformationen in dGVzdElkOnRlc3RTZWNyZXQ= konvertiert.
• Übergeben Sie die HTTP-Kopfzeilen Authorization:Basic <base-64 clientID:clientSecret> und Content-Type: application/x-www-form-urlencoded. Ihre Kopfzeile könnte zum Beispiel wie folgt aussehen:
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• Geben Sie im Anfragetext den grant_type:refresh_token an und übergeben Sie das Aktualisierungs-Token, das Sie in Ihrer vorherigen Zugriffsanfrage erhalten haben. Die Anfrage sollte wie folgt aussehen:
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

Schritt 2: Neues Token erhalten

Die JSON-Antwort enthält Ihr neues Zugriffstoken. Die Antwort sollte wie folgt aussehen:

{
    "access_token": "4fdfc261-2ffc-4fb7-8dbd-64221714c45f",
    "token_type": "bearer",
    "refresh_token": "295fa487-1825-4caa-a715-80b81ac17dae",
    "expires_in": 21922,
    "scope": "read write"
}

Autorisierungs-Code und implizite Authentifizierung authentication-code-implicit

Die Audience Manager-REST API unterstützt Autorisierungs-Code und implizite Authentifizierung. Um diese Zugriffsmethoden verwenden zu können, müssen sich Ihre Benutzer bei https://api.demdex.com/oauth/authorize anmelden, um Zugriffs- und Aktualisierungs-Token zu erhalten.