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 Entwickler. Er umfasst APIs für alle Adobe-Produkte.

Dies ist die empfohlene Einrichtung und Verwendung von Adobe APIs.

Voraussetzungen prerequisites

Vor der Konfiguration JWT Authentifizierung, stellen Sie sicher, dass Sie Zugriff auf die Adobe Developer-Konsole in Adobe Developer. Wenden Sie sich für Zugriffsanfragen an Ihren Organisationsadministrator.

Authentifizierung auth

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

1. Melden Sie sich bei Adobe Developer-Konsole.
2. Führen Sie die Schritte unter Service-Konto-Verbindung.
   • Während Schritt 2: Hinzufügen einer API zu Ihrem Projekt mithilfe der Authentifizierung für Dienstkonten, wählen Sie die Audience Manager API -Option.
3. Probieren Sie die Verbindung aus, indem Sie Ihre erste API -Aufruf basierend auf den Anweisungen von Schritt 3.

RBAC-Berechtigungen für technische Konten

Wenn Ihr Audience Manager-Konto Rollenbasierte Zugriffssteuerungmü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. Erstellen Sie eine GET Aufruf von https://aam.adobe.io/v1/users/self. Durch den Aufruf wird ein technisches Benutzerkonto erstellt, das Sie im Admin Consolein der Users Seite.

   

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

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

Generische Elemente erstellen API Benutzer requirements

Es wird empfohlen, ein eigenes technisches Benutzerkonto für die Arbeit mit der Audience Manager APIs. Dies ist ein allgemeines Konto, das nicht an einen bestimmten Benutzer in Ihrem Unternehmen gebunden ist oder mit diesem verknüpft ist. Diese Art von API Mit dem Benutzerkonto können Sie zwei Dinge erreichen:

• Identifizieren, welcher Dienst die API (z. B. Aufrufe aus Ihren Apps, die unsere APIs oder von anderen Werkzeugen, die API -Anfragen).
• Ununterbrochenen 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 den verfügbaren API Code. 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 der Tools für die Massenverwaltung. Dazu benötigt Ihr Benutzerkonto API Zugriff. Anstatt einem bestimmten Benutzer Berechtigungen hinzuzufügen, erstellen Sie eine unspezifische API Benutzerkonto mit den entsprechenden Anmeldeinformationen, Schlüsseln und Geheimnissen für API -Aufrufe. Dies ist auch nützlich, wenn Sie eigene Anwendungen entwickeln, die die Audience Manager APIs.

Arbeiten mit Audience Manager Berater, um eine generische API- nur Benutzerkonto.

Workflow zur Kennwortauthentifizierung password-authentication-workflow

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

Schritt 1: Anforderung API Zugriff

Wenden Sie sich an Ihren Partner Solutions Manager. Sie werden Ihnen eine API Client-ID und geheimer Schlüssel. Die Kennung und das Geheimnis authentifizieren Sie bei der API.

Hinweis: Wenn Sie ein Aktualisierungstoken erhalten möchten, geben Sie dies bei Anforderung an API Zugriff.

Schritt 2: Anfordern des Tokens

Übergeben einer Token-Anfrage mit Ihrer bevorzugten JSON Client. Wenn Sie die Anforderung erstellen:

• Verwenden Sie eine POST -Methode zum Aufrufen https://api.demdex.com/oauth/token.
• 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 die Anmeldedaten testId : testSecret konvertieren in dGVzdElkOnRlc3RTZWNyZXQ=.
• Ü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 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"
}

Die expires_in key 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

Token aktualisieren erneuern API -Zugriff nach Ablauf des ursprünglichen Tokens. Auf Anfrage wird die Antwort JSON enthält 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 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 aus einem JSON Client in Ihrem Browser.

Schritt 1: Anfordern des neuen Tokens

Übergeben einer Aktualisierungs-Token-Anforderung mit Ihrer bevorzugten JSON Client. Wenn Sie die Anforderung erstellen:

• Verwenden Sie eine POST -Methode zum Aufrufen https://api.demdex.com/oauth/token.
• 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 die Anmeldedaten testId : testSecret konvertieren in dGVzdElkOnRlc3RTZWNyZXQ=.
• Übergeben von HTTP-Headern 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 Anfrageinhalt die grant_type:refresh_token und geben Sie das Aktualisierungs-Token weiter, 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: Empfangen des neuen Tokens

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

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 , um auf Token zuzugreifen und sie zu aktualisieren.