Developer Console einrichten und Postman

In this lesson, you will set up a project in the Adobe Developer Console and download Postman collections so you can start using Platform APIs.

In order to complete the API exercises in this tutorial, download the Postman app for your operating system. Postman ist zwar nicht erforderlich, um Experience Platform-APIs zu verwenden, aber es erleichtert die API-Workflows und Adobe Experience Platform bietet Dutzende von Postman-Sammlungen, mit denen Sie API-Aufrufe ausführen und erfahren können, wie sie funktionieren. Der Rest dieses Tutorials geht davon aus, dass einige Arbeitskenntnisse des Postmanns vorhanden sind. Weitere Informationen finden Sie unter Postmanische Dokumentation.

Plattform ist API-first. Während Schnittstellenoptionen für alle wichtigen Aufgaben vorhanden sind, sollten Sie die Plattform-API irgendwann verwenden. Um beispielsweise Daten zu erfassen, verschieben Sie Elemente zwischen Sandboxen, automatisieren routinemäßige Aufgaben oder verwenden Sie neue Plattformfunktionen, bevor die Benutzeroberfläche erstellt wurde.

Datenarchitekten und Dateningenieure müssen möglicherweise die Plattform-API außerhalb dieses Tutorials verwenden.

Berechtigungen erforderlich

In Berechtigungen konfigurieren Lektion erstellen Sie alle Zugriffskontrollen, die zum Abschluss dieser Lektion erforderlich sind.

Adobe Developer Console einrichten

  1. Erstellen Sie auf Ihrem lokalen Computer einen Ordner mit dem Namen Luma Tutorial Assets für Dateien, die im Tutorial verwendet werden.

  2. Öffnen Sie die Adobe Developer Console

  3. Melden Sie sich an und bestätigen Sie, dass Sie sich in der richtigen Org-Datei befinden

  4. Auswählen Neues Projekt erstellen in Quick Beginn Menü.

    Neues Projekt erstellen

  5. In the newly created project, select the Add to Project button and then select API

    Konfiguration der Adobe Developer Console Project API

  6. Filtern der Liste durch Auswahl von Adobe Experience Platform

  7. Wählen Sie in Liste der verfügbaren APIs Experience Platform-API und wählen Weiter.

    Konfiguration der Adobe Developer Console Project API

  8. Für die Authentifizierung von externen Systemen wie Postman, benötigen wir ein öffentliches/privates Schlüsselpaar. Um ein neues Schlüsselpaar zu erstellen, wählen Sie Option 1 und drücken Sie die Schlüsselbild generieren Schaltfläche

    Konfiguration der Adobe Developer Console Project API

  9. Sobald die Schlüssel bereit sind, werden Sie möglicherweise aufgefordert, die Schlüssel auf Ihren lokalen Computer herunterzuladen. Speichern Sie die Schlüssel im Paket config.zip in den Ordner Luma Tutorial Assets. Wir werden sie bei der nächsten Übung brauchen.

  10. Nachdem der Schlüssel erstellt wurde, wird der öffentliche Schlüssel automatisch zu Ihrem Projekt hinzugefügt, wie im Screenshot dargestellt. Wählen Sie Weiter Schaltfläche.

     View After Key is Generated and selected

  11. Select the Luma Tutorial Platform product profile and select the Save Configured API button

    Profil auswählen

  12. Now your Developer Console project has been created!

  13. In Probieren Sie es aus Abschnitt der Seite auswählen Für Postman herunterladen und wählen Sie dann Dienstkonto (JWT) , um Postman JSON-Datei der Umgebung. Save the service.postman_environment.json in your Luma Tutorial Assets folder.

    Konfiguration der Adobe Developer Console Project API

    HINWEIS

    Systemadministratoren Ihres Unternehmens können das Projekt als "API-Anmeldedaten"im Profil des Produkts in der Admin Console betrachten.

    Konfiguration der Adobe Developer Console Project API

Sie haben vielleicht bemerkt, dass dem Projekt eine Nummer zugewiesen wurde, z. B. "Projekt 12":

  1. Wählen Sie die Projektnummer in der Breadcrumb aus

  2. Wählen Sie Projekt bearbeiten Schaltfläche

  3. Ändern der Projekttitel nach Luma Tutorial API Project (fügen Sie Ihren Namen hinzu, wenn mehrere Personen Ihrer Firma diesen Lehrgang absolvieren)

  4. Klicken Sie auf die Schaltfläche Speichern

    Konfiguration der Adobe Developer Console Project API

Post einrichten

VORSICHT

Die Postman-Schnittstelle wird regelmäßig aktualisiert. Die Screenshots in diesem Tutorial wurden mit Postman v9.0.5 für Mac gemacht, aber die Schnittstellenoptionen haben sich möglicherweise geändert.

  1. Herunterladen und installieren Postman

  2. Open Postman and import the downloaded json environment file, service.postman_environment.json
    Import environment

  3. In Postman, wählen Sie Ihre Umgebung im Dropdown-Menü aus

    Change environment

  4. Wählen Sie Auge Symbol zur Ansicht der Umgebung-Variablen:

    Konfiguration der Adobe Developer Console Project API

Name der Umgebung aktualisieren

Since the exported name of the environment from Developer Console is randomly generated, give it a more descriptive name so you don't confuse environments later on when you start working on your real Platform implementation:

  1. With the environment variables screen still open, select Edit on the top-right

  2. Aktualisieren Sie die Name der Umgebung nach Luma Tutorial

  3. Verlassen Umgebung verwalten Modal im Bearbeitungsmodus geöffnet, da wir es im nächsten Schritt weiter bearbeiten werden

    Update the Postman Environment Name

Privaten Schlüssel Hinzufügen

Now it's time to add the PRIVATE_KEY value to the Postman environment

  1. Download extrahieren config.zip Datei, die in der vorherigen Übung beim Erstellen des Developer Console-Projekts erstellt wurde. Diese ZIP-Datei enthält zwei Dateien:

    • private.key
    • certificate_pub.crt
  2. Open the private.key file in a text editor and copy the contents.

  3. In Postman, on the Manage Environments > Edit modal which is still open from the last exercise, paste copied values in front of PRIVATE_KEY in the Initial Value and Current Value columns.

  4. Wählen Sie Speichern aus

    Privater Schlüssel in Postman eingefügt

Add the JWT and Access Tokens

Adobe bietet einen umfangreichen Satz von Postman Sammlungen, mit denen Sie die API der Experience Platform erkunden können. Diese Sammlungen befinden sich in Adobe Experience Platform Postman Samples GitHub-Repo. Sie sollten diesen Bericht mit einem Lesezeichen versehen, da Sie dies in diesem Tutorial mehrmals verwenden und später Experience Platform für Ihre eigene Firma implementieren.

Die erste Sammlung funktioniert mit den Adobe Identity Management Service (IMS) APIs. Es ist eine bequeme Möglichkeit, JWT_TOKEN und ACCESS_TOKEN von Postman aus zu befüllen für nicht produktionsbezogene Verwendungszwecke wie das Ausfüllen dieses Tutorials in Ihrer Sandbox. Alternativ kann der JWT-Token in der Adobe Developer Console erstellt werden. Da diese Sammlung jedoch regelmäßig abläuft, können Sie sie mit dieser Sammlung aktualisieren, ohne die Adobe Developer Console erneut aufrufen zu müssen, während Sie dieses Tutorial abschließen.

WARNUNG

Wie bereits im Adobe Identity Management Service APIs BEREIT, sind die angegebenen Erzeugungsmethoden für die Verwendung in der Nicht-Produktion geeignet. Beim lokalen Signieren wird eine JavaScript-Bibliothek von einem Drittanbieter-Host geladen und beim Remote-Signieren wird der private Schlüssel an einen Webdienst der Adobe gesendet. Dieser private Schlüssel wird in der Adobe zwar nicht gespeichert, die Produktionsschlüssel sollten jedoch niemals für irgendjemanden freigegeben werden.

So generieren Sie die Token:

  1. Laden Sie die Developer Console Zugriffstoken Generation Collection , um Luma Tutorial Assets Ordner

  2. Sammlung importieren in Postman

  3. Anforderung auswählen IMS: JWT-Generierung + Auth über Benutzer-Token und wählen Senden

    Token anfordern

  4. Die JWT_TOKEN und ACCESS_TOKEN in den Umgebung-Variablen von Postman.

    Postman

Sandbox-Name und Mandanten-ID Hinzufügen

Die SANDBOX_NAME und TENANT_ID und CONTAINER_ID Variablen sind nicht im Export der Adobe Developer Console enthalten, daher werden sie manuell hinzugefügt:

  1. In Postman, open the Environment Variables

  2. Wählen Sie Bearbeiten Link rechts neben dem Namen der Umgebung

  3. In Neues Variablenfeld Hinzufügen, eingeben SANDBOX_NAME

  4. In beide Wertefelder eingeben luma-tutorial, der Name, den wir in der vorherigen Lektion unserer Sandbox gegeben haben. Wenn Sie einen anderen Namen für Ihre Sandbox verwendet haben, z. B. luma-tutorial-ignatiusjreilly, stellen Sie sicher, dass Sie diesen Wert verwenden.

  5. In Neues Variablenfeld Hinzufügen, eingeben TENANT_ID

  6. Wechseln Sie zu Ihrem Webbrowser und suchen Sie die Mandanten-ID Ihrer Firma, indem Sie die Benutzeroberfläche der Experience Platform aufrufen und den Teil der URL extrahieren nach dem @-Zeichen. Meine Mandanten-ID ist z. B. techmarketingdemos aber Ihrer ist anders:

    Beziehen der Mandanten-ID von der URL der Plattform-Benutzeroberfläche

  7. Diesen Wert kopieren und zurück zu Postman Bildschirm "Umgebung verwalten"

  8. Pächter-ID in beide Wertefelder einfügen

  9. In Neues Variablenfeld Hinzufügen, eingeben CONTAINER_ID

  10. Eingabe global in beide Wertefelder

    HINWEIS

    CONTAINER_ID ist ein Feld, dessen Wert wir mehrmals während des Tutorials ändern. When global is used, the API interacts with Adobe-provided elements in your Platform account. Wann tenant verwendet wird, interagiert die API mit Ihren eigenen benutzerspezifischen Elementen.

  11. Wählen Sie Speichern aus

    SANDBOX_NAME, TENANT_ID und CONTAINER_ID wurden als Umgebung-Variablen hinzugefügt

Plattform-API-Aufruf erstellen

Lassen Sie uns nun einen Platform API-Aufruf durchführen, um zu bestätigen, dass wir alles richtig konfiguriert haben.

Öffnen Sie die Experience Platform Postman Sammlungen in GitHub. Auf dieser Seite gibt es viele Sammlungen für verschiedene Plattform-APIs. Ich empfehle dringend, es mit Lesezeichen zu versehen.

Nun, machen wir unseren ersten API-Aufruf:

  1. Laden Sie die Schema Registry API-Sammlung , um Luma Tutorial Assets Ordner
  2. Importieren in Postman
  3. Öffnen Schema-Registry-API > Klassen > Eine Liste von Klassen innerhalb des angegebenen Containers abrufen.
  4. Schauen Sie sich die Parameter und Kopfzeilen -Tabs und beachten Sie, dass sie einige der zuvor eingegebenen Umgebung enthalten.
  5. Beachten Sie, dass Überschriften > Wertefeld akzeptieren ist eingestellt auf application/vnd.adobe.xed-id+json. Die Schema-Registry-APIs erfordern eine dieser angegebene Kopfzeilenwerte akzeptieren die verschiedene Formate in der Antwort bereitstellen.
  6. Select Send to make your first Platform API call!

Hoffentlich haben Sie einen Erfolg 200 OK Antwort mit einer Liste der verfügbaren Standard-XDM-Klassen in Ihrer Sandbox, wie unten dargestellt.

First API call in Postman

Wenn Ihr Anruf nicht erfolgreich war, versuchen Sie es mit den Fehlerantwort-Details des API-Aufrufs und überprüfen Sie die oben stehenden Schritte. Wenn Sie festsitzen, bitten Sie um Hilfe im Community-Forum oder verwenden Sie den Link auf der rechten Seite dieser Seite, um ein Problem zu protokollieren.

Weitere Ressourcen

With your Platform permissions, sandbox, and Postman set up, you are ready to model data in schemas!

Auf dieser Seite