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

Übersicht über Adobe Developer adobeio

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

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

Voraussetzungen prerequisites

Bevor Sie die JWT-Authentifizierung konfigurieren können, stellen Sie sicher, dass Sie Zugriff auf die Adobe Developer Console in Adobe Developer haben. Wenden Sie sich für Zugriffsanfragen an Ihren Organisationsadministrator.

Authentifizierung auth

Gehen Sie wie folgt vor, um die JWT (Service Account)-Authentifizierung mit Adobe Developer zu konfigurieren:

1. Melden Sie sich bei Adobe Developer Console an.
2. Führen Sie die Schritte unter Verbindung mit Dienstkonten aus.
   • Wählen Sie während Schritt 2: Hinzufügen einer API zu Ihrem Projekt mithilfe der Dienstkontoauthentifizierung die Option Audience Manager API aus.
3. Probieren Sie die Verbindung aus, indem Sie Ihren ersten API -Aufruf anhand der Anweisungen aus Schritt 3 durchführen.

RBAC-Berechtigungen für technische Konten

Wenn Ihr Audience Manager-Konto die rollenbasierte Zugriffssteuerung verwendet, müssen Sie ein technisches Audience Manager-Benutzerkonto erstellen und es der Audience Manager-RBAC-Gruppe 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 GET auf https://aam.adobe.io/v1/users/self. Durch den Aufruf wird ein technisches Benutzerkonto erstellt, das Sie auf der Seite Users unter Admin Console sehen können.

   

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

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

Generischen API Benutzer erstellen 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 an einen bestimmten Benutzer in Ihrem Unternehmen gebunden ist oder mit diesem verknüpft ist. Mit diesem Benutzerkonto vom Typ API können Sie zwei Dinge erreichen:

• Identifizieren Sie, welcher Dienst die API aufruft (z. B. Aufrufe aus Ihren Apps, die unsere API verwenden, oder aus anderen Tools, die API -Anfragen stellen).
• Gewähren Sie unterbrechungsfreien Zugriff auf die APIs. Ein Konto, das an eine bestimmte Person gebunden ist, kann gelöscht werden, wenn sie 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.

Nehmen wir als Beispiel oder Anwendungsfall für diesen Kontotyp an, Sie möchten viele Segmente gleichzeitig mit den Tools für die Massenverwaltung ändern. Dazu benötigt Ihr Benutzerkonto API Zugriff. Anstatt einem bestimmten Benutzer Berechtigungen hinzuzufügen, erstellen Sie ein unspezifisches Benutzerkonto mit dem Namen API , 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 eigene Anwendungen entwickeln, die die Audience Manager APIs verwenden.

Arbeiten Sie mit Ihrem Audience Manager -Berater zusammen, um ein generisches Benutzerkonto einzurichten, das nur für API gilt.

Workflow zur Kennwortauthentifizierung password-authentication-workflow

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

Schritt 1: Anfordern des Zugriffs auf API

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

Hinweis: Wenn Sie ein Aktualisierungstoken erhalten möchten, geben Sie dies an, wenn Sie den Zugriff auf API anfordern.

Schritt 2: Anfordern des Tokens

Übergeben Sie eine Token-Anfrage an Ihren bevorzugten JSON-Client. Wenn Sie die Anforderung erstellen:

• Verwenden Sie eine POST -Methode, um https://api.demdex.com/oauth/token aufzurufen.
• Konvertieren Sie Ihre Client-ID und Ihr Geheimnis in eine Base-64-kodierte Zeichenfolge. Trennen Sie die ID und das Geheimnis während des Konvertierungsprozesses durch einen Doppelpunkt. Beispielsweise werden die Anmeldedaten testId : testSecret in dGVzdElkOnRlc3RTZWNyZXQ= konvertiert.
• Übergeben Sie die HTTP headers Authorization:Basic <base-64 clientID:clientSecret> und Content-Type: application/x-www-form-urlencoded. Die Kopfzeile könnte beispielsweise 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 erhalten

Die Antwort JSON 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 Schlüssel expires_in gibt die Anzahl der Sekunden an, bis das Zugriffstoken abläuft. Es hat sich bewährt, kurze Ablaufzeiten zu verwenden, um die Exposition zu begrenzen, wenn das Token jemals offen gelegt wird.

Token aktualisieren refresh-token

Aktualisieren Sie Token, um den API -Zugriff zu verlängern, nachdem das ursprüngliche Token abläuft. Bei Bedarf enthält die Antwort JSON im Kennwort-Workflow ein Aktualisierungstoken. Wenn Sie kein Aktualisierungstoken erhalten, erstellen Sie mithilfe des Kennwortauthentifizierungsprozesses ein neues.

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

Wenn Ihr Zugriffstoken abgelaufen ist, erhalten Sie einen 401 Status Code -Wert 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-Client. Wenn Sie die Anforderung erstellen:

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

Schritt 2: Empfangen des neuen Tokens

Die Antwort JSON 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"
}

Autorisierungscode und implizite Authentifizierung authentication-code-implicit

Die Audience Manager REST API unterstützt Autorisierungscode und implizite Authentifizierung. Um diese Zugriffsmethoden verwenden zu können, müssen sich Ihre Benutzer bei https://api.demdex.com/oauth/authorize anmelden, um Zugriff auf Token zu erhalten und sie zu aktualisieren.