Einrichten der Entwicklerkonsole und Postman

In dieser Lektion richten Sie ein Projekt in der Adobe Developer-Konsole ein und laden Postman Sammlungen, damit Sie mit der Verwendung von Platform-APIs beginnen können.

Um die API-Übungen in diesem Tutorial abzuschließen, müssen Sie Laden Sie die Postman-App für Ihr Betriebssystem herunter. Postman ist zwar nicht erforderlich, um Experience Platform-APIs zu verwenden, erleichtert aber API-Workflows. Adobe Experience Platform bietet Dutzende von Postman-Kollektionen, die Ihnen bei der Ausführung von API-Aufrufen und der Funktionsweise helfen. Im Rest dieses Tutorials werden einige Kenntnisse über Postman vorausgesetzt. Informationen zur Unterstützung finden Sie im Abschnitt Postman-Dokumentation.

Platform ist als API-Erste konzipiert. Auch wenn Schnittstellenoptionen für alle Hauptaufgaben vorhanden sind, sollten Sie die Platform-API irgendwann verwenden. Um beispielsweise Daten zu erfassen, verschieben Sie Elemente zwischen Sandboxes, automatisieren Sie Routineaufgaben oder verwenden Sie neue Platform-Funktionen, bevor die Benutzeroberfläche erstellt wurde.

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

Erforderliche Berechtigungen

Im Berechtigungen konfigurieren Lektion erstellen Sie alle Zugriffssteuerungen, die zum Abschluss dieser Lektion erforderlich sind.

Einrichten der Adobe Developer-Konsole

Adobe Developer Console ist das Entwicklerziel für den Zugriff auf Adobe-APIs und SDKs, das Abhören von nahezu Echtzeit-Ereignissen, das Ausführen von Funktionen in Runtime oder das Erstellen von Plug-ins oder App Builder-Apps. Sie greifen damit auf die Experience Platform-API zu. Weitere Informationen finden Sie unter Dokumentation zur Adobe Developer Console

  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-Konsole

  3. Melden Sie sich an und vergewissern Sie sich, dass Sie sich in der richtigen Organisation befinden

  4. Auswählen Neues Projekt erstellen in Schnellstart Menü.

    Neues Projekt erstellen

  5. Wählen Sie im neu erstellten Projekt die Zum Projekt hinzufügen und wählen Sie API

    Konfiguration der Adobe Developer Console-Projekt-API

  6. Filtern der Liste durch Auswahl Adobe Experience Platform

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

    Konfiguration der Adobe Developer Console-Projekt-API

  8. Für die Authentifizierung durch externe Systeme wie Postman, benötigen wir ein Paar aus öffentlichem/privatem Schlüssel. Um ein neues Schlüsselpaar zu generieren, wählen Sie Option 1 und drücken Sie die Generieren von keypair button

    Konfiguration der Adobe Developer Console-Projekt-API

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

  10. Nachdem der Schlüssel generiert wurde, wird der öffentliche Schlüssel automatisch zum Projekt hinzugefügt, wie im Screenshot gezeigt. Wählen Sie die Nächste Schaltfläche.

     Anzeigen nach der Generierung und Auswahl des Schlüssels

  11. Wählen Sie die Luma Tutorial Platform Produktprofil und wählen Sie die Konfigurierte API speichern button

    Profil auswählen

  12. Jetzt wurde Ihr Entwicklerkonsole-Projekt erstellt!

  13. Im Testen -Abschnitt der Seite, wählen Sie Herunterladen für Postman und wählen Sie Dienstkonto (JWT) zum Herunterladen der Postman Umgebungs-JSON-Datei. Speichern Sie die service.postman_environment.json in Luma Tutorial Assets Ordner.

    Konfiguration der Adobe Developer Console-Projekt-API

    HINWEIS

    Systemadministratoren Ihres Unternehmens können das Projekt als "API-Berechtigung"im Produktprofil in der Admin Console anzeigen.

    Konfiguration der Adobe Developer Console-Projekt-API

Möglicherweise ist Ihnen aufgefallen, dass dem Projekt eine Nummer zugewiesen wurde, z. B. "Projekt 12":

  1. Wählen Sie die Projektnummer im Breadcrumb aus.

  2. Wählen Sie die Projekt bearbeiten button

  3. Ändern Sie die Projekttitel nach Luma Tutorial API Project (Fügen Sie am Ende Ihren Namen hinzu, wenn mehrere Personen aus Ihrem Unternehmen dieses Tutorial absolvieren)

  4. Klicken Sie auf die Schaltfläche Speichern

    Konfiguration der Adobe Developer Console-Projekt-API

Einrichten von Postman

VORSICHT

Die Benutzeroberfläche von Postman wird regelmäßig aktualisiert. Die Screenshots in diesem Tutorial wurden mit Postman Version 9.0.5 für Mac erstellt, die Benutzeroberflächenoptionen wurden jedoch möglicherweise geändert.

  1. Herunterladen und installieren Postman

  2. Öffnen Postman und importieren Sie die heruntergeladene JSON-Umgebungsdatei, service.postman_environment.json
    Importumgebung

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

    Umgebung ändern

  4. Wählen Sie die Auge -Symbol, um die Umgebungsvariablen anzuzeigen:

    Konfiguration der Adobe Developer Console-Projekt-API

Aktualisieren des Umgebungsnamens

Da der exportierte Name der Umgebung aus der Developer Console zufällig generiert wird, geben Sie ihr einen beschreibenden Namen, damit Sie Umgebungen später nicht verwirren, wenn Sie mit der eigentlichen Platform-Implementierung beginnen:

  1. Wenn der Bildschirm "Umgebungsvariablen"noch geöffnet ist, wählen Sie Bearbeiten oben rechts

  2. Aktualisieren Sie die Umgebungsname nach Luma Tutorial

  3. Urlaub Verwalten von Umgebungen Modal im Bearbeitungsmodus öffnen, da wir sie im nächsten Schritt weiter bearbeiten werden

    Aktualisieren des Postman-Umgebungsnamens

Privaten Schlüssel hinzufügen

Jetzt ist es an der Zeit, den Wert PRIVATE_KEY zur Postman-Umgebung hinzuzufügen

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

    • private.key
    • certificate_pub.crt
  2. Öffnen Sie die private.key in einen Texteditor einfügen und den Inhalt kopieren.

  3. In Postman im Verwalten von Umgebungen > Bearbeiten -Modal, das nach der letzten Übung noch geöffnet ist, kopieren Sie die kopierten Werte vor PRIVATE_KEY im Anfangswert und Aktueller Wert Spalten.

  4. Wählen Sie Speichern aus

    In Postman eingefügter privater Schlüssel

JWT- und Zugriffstoken hinzufügen

Adobe bietet eine umfangreiche Auswahl an Postman Sammlungen, die Ihnen bei der Erforschung der API von Experience Platform helfen. Diese Sammlungen befinden sich im Adobe Experience Platform Postman-Beispiele für GitHub-Repository. Sie sollten dieses Repo mit einem Lesezeichen versehen, da Sie es in diesem Tutorial und später bei der Implementierung der Experience Platform für Ihr eigenes Unternehmen mehrmals verwenden werden.

Die erste Sammlung funktioniert mit den Adobe Identity Management Service (IMS)-APIs. Dies ist eine praktische Möglichkeit, JWT_TOKEN und ACCESS_TOKEN aus Postman zu füllen. für nicht produktionsfremde Anwendungsfälle z. B. dieses Tutorial in Ihrer Sandbox absolvieren. Alternativ kann das JWT-Token in der Adobe Developer-Konsole generiert werden. Da diese Sammlung jedoch regelmäßig abläuft, können Sie sie mit dieser Sammlung aktualisieren, ohne die Adobe Developer-Konsole erneut aufrufen zu müssen, während Sie dieses Tutorial absolvieren.

WARNUNG

Wie im Abschnitt Adobe Identity Management Service APIs - README, sind die angegebenen Erzeugungsmethoden für die Verwendung ohne Produktionscharakter geeignet. "Lokales Signieren"lädt eine JavaScript-Bibliothek von einem Drittanbieter-Host und das Remote-Signieren sendet den privaten Schlüssel an einen von Adoben verwalteten und verwalteten Webdienst. Während Adobe diesen privaten Schlüssel nicht speichert, sollten Produktionsschlüssel nie für andere freigegeben werden.

So generieren Sie die Token:

  1. Laden Sie die Erfassung von Zugriffstoken für die Entwicklerkonsole auf Luma Tutorial Assets Ordner

  2. Importieren Sie die Sammlung in Postman

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

    Token anfordern

  4. Die JWT_TOKEN und ACCESS_TOKEN automatisch in die Umgebungsvariablen von Postman.

    Postman

Sandbox-Name und Mandanten-ID hinzufügen

Die SANDBOX_NAME und TENANT_ID und CONTAINER_ID -Variablen sind nicht im Adobe Developer Console-Export enthalten, daher fügen wir sie manuell hinzu:

  1. In Postman, öffnen Sie die Umgebungsvariablen

  2. Wählen Sie die Bearbeiten Link rechts neben dem Umgebungsnamen

  3. Im Neues Variablenfeld hinzufügen, eingeben SANDBOX_NAME

  4. Geben Sie in beide Wertfelder ein. luma-tutorial, der Name, den wir unserer Sandbox in der vorherigen Lektion 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. Im Neues Variablenfeld hinzufügen, eingeben TENANT_ID

  6. Wechseln Sie zu Ihrem Webbrowser und suchen Sie nach der Mandanten-ID Ihres Unternehmens, indem Sie die Benutzeroberfläche von Experience Platform aufrufen und den Teil der URL extrahieren. nach dem @-Zeichen. Beispielsweise lautet meine Mandanten-ID techmarketingdemos aber Ihre ist anders:

    Beziehen der Mandanten-ID über die Platform-URL

  7. Kopieren Sie diesen Wert und kehren Sie zum Postman Bildschirm "Umgebungen verwalten"

  8. Fügen Sie Ihre Mandanten-ID in beide Wertfelder ein.

  9. Im Neues Variablenfeld hinzufügen, eingeben CONTAINER_ID

  10. Eingabe global in beide Wertfelder

    HINWEIS

    CONTAINER_ID ist ein Feld, dessen Wert wir während des Tutorials mehrmals ändern. Wann global verwendet wird, interagiert die API mit von Adobe bereitgestellten Elementen in Ihrem Platform-Konto. Wann tenant verwendet wird, interagiert die API mit Ihren eigenen benutzerdefinierten Elementen.

  11. Wählen Sie Speichern aus

    Die Felder SANDBOX_NAME, TENANT_ID und CONTAINER_ID wurden als Umgebungsvariablen hinzugefügt

Einrichten eines Platform-API-Aufrufs

Nehmen wir nun einen Platform-API-Aufruf vor, um zu bestätigen, dass wir alles korrekt konfiguriert haben.

Öffnen Sie die Experience Platform Postman Sammlungen in GitHub. Auf dieser Seite finden Sie viele Sammlungen für verschiedene Platform-APIs. Ich empfehle dringend, ein Lesezeichen zu setzen.

Nehmen wir nun unseren ersten API-Aufruf vor:

  1. Laden Sie die Schema Registry-API-Sammlung auf Luma Tutorial Assets Ordner
  2. Importieren in Postman
  3. Öffnen Schema Registry-API > Klassen > Listenklassen
  4. Sehen Sie sich die Parameter und Kopfzeilen -Tabs und beachten Sie, dass sie einige der zuvor eingegebenen Umgebungsvariablen enthalten.
  5. Beachten Sie Folgendes: Kopfzeilen > Wertefeld akzeptieren auf application/vnd.adobe.xed-id+json. Für die Schema Registry-APIs ist eine dieser Voraussetzungen erforderlich angegebene Accept-Kopfzeilenwerte , die unterschiedliche Formate in der Antwort bereitstellen.
  6. Auswählen Senden , um Ihren ersten Platform-API-Aufruf durchzuführen!

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

Erster API-Aufruf in Postman

Wenn Ihr Aufruf nicht erfolgreich war, versuchen Sie einen Moment, das Debugging mithilfe der Fehlerantwortendetails des API-Aufrufs durchzuführen und überprüfen Sie die oben beschriebenen Schritte. Wenn Sie feststecken bleiben, bitten Sie um Hilfe im Community-Forum oder verwenden Sie den Link rechts auf dieser Seite, um ein Problem zu protokollieren.

Mit Ihren Plattformberechtigungen, Sandbox und Postman einrichten, können Sie Modelldaten in Schemata!

Auf dieser Seite