Dokumentation Experience Platform Einrichten von Developer Console und Postman

Einrichten von Developer Console und Postman

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:
API

Erstellt für:

Einsteiger
Fortgeschrittener
Entwickler

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

Laden Sie die Postman-App für Ihr Betriebssystem herunter, um die in diesem Tutorial beschriebenen API-Übungen abzuschließen.🔗 Obwohl dies für die Verwendung von Experience Platform-APIs nicht erforderlich ist, erleichtert Postman API-Workflows und Adobe Experience Platform bietet Dutzende von Postman-Sammlungen, mit denen Sie API-Aufrufe ausführen und lernen können, wie sie funktionieren. Im Rest dieses Tutorials werden einige Kenntnisse über Postman vorausgesetzt. Hilfe finden Sie in der 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üssen möglicherweise die Platform-API außerhalb dieses Tutorials verwenden.

Erforderliche Berechtigungen

In der Lektion Berechtigungen konfigurieren richten Sie alle Zugriffssteuerungen ein, die zum Abschluss dieser Lektion erforderlich sind.

Einrichten von Adobe Developer Console

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 auf Runtime oder das Erstellen von Plug-ins oder App Builder-Anwendungen. Sie werden es verwenden, um auf die Experience Platform-API zuzugreifen. Weitere Informationen finden Sie in der Adobe Developer Console-Dokumentation .

Erstellen Sie auf Ihrem lokalen Computer einen Ordner mit dem Namen Luma Tutorial Assets für die in der Anleitung verwendeten Dateien.
Öffnen Sie den Adobe Developer Console
Melden Sie sich an und bestätigen Sie, dass Sie sich in der richtigen Organisation befinden
Wählen Sie Neues Projekt erstellen im Menü Schnellstart aus.
Wählen Sie im neu erstellten Projekt die Schaltfläche Projekt bearbeiten aus
Ändern Sie den Projekttitel in Luma Tutorial API Project (fügen Sie Ihren Namen zum Ende hinzu, wenn mehrere Personen aus Ihrem Unternehmen dieses Tutorial absolvieren).
Wählen Sie Speichern aus.
Wählen Sie API hinzufügen
Filtern Sie die Liste, indem Sie Adobe Experience Platform auswählen
Wählen Sie in der Liste der verfügbaren APIs Experience Platform-API und dann Weiter aus.
Wählen Sie OAuth Server-to-Server als Berechtigung aus und wählen Sie Weiter aus.
aus.
Wählen Sie das Produktprofil AEP-Default-All-Users aus und wählen Sie Konfigurierte API speichern
Jetzt wurde Ihr Developer Console-Projekt erstellt!
Wählen Sie im Abschnitt Testen Sie es aus der Seite die Option Für Postman herunterladen und klicken Sie dann auf OAuth Server-to-Server , um die JSON-Datei der Umgebung Postman herunterzuladen. Speichern Sie die oauth_server_to_server.postman_environment.json in Ihrem Luma Tutorial Assets -Ordner.

Bitten Sie einen Systemadministrator, die API-Berechtigung zur Rolle hinzuzufügen.

Damit Sie die API-Anmeldeinformationen für die Interaktion mit Experience Platform verwenden können, muss ein Systemadministrator die API-Anmeldeinformationen der in der vorherigen Lektion erstellten Rolle zuweisen. Wenn Sie kein Systemadministrator sind, senden Sie ihnen Folgendes:

Der Name Ihrer API-Anmeldedaten (Credential in Luma Tutorial API Project)
Die E-Mail-Adresse des technischen Kontos Ihrer Anmeldedaten (dadurch kann der Systemadministrator die Berechtigung finden)

Hier finden Sie die Anweisungen für den Systemadministrator:

Anmelden bei Adobe Experience Platform
Wählen Sie Berechtigungen im linken Navigationsbereich aus, der Sie zum Bildschirm Rollen führt.
Öffnen Sie die Rolle Luma Tutorial Platform .
Wählen Sie die Registerkarte API-Anmeldeinformationen aus.
Wählen Sie API-Anmeldeinformationen hinzufügen aus.
Suchen Sie die Credential in Luma Tutorial API Project -Berechtigung und filtern Sie mit der vom Teilnehmer des Tutorials bereitgestellten E-Mail-Konto für das technische Konto, wenn die Liste lang ist.
Berechtigung auswählen
Wählen Sie Speichern aus.

Einrichten von Postman

CAUTION

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

Herunterladen und Installieren von Postman
Öffnen Sie Postman und erstellen Sie einen Arbeitsbereich.
Importieren Sie die heruntergeladene JSON-Umgebungsdatei, oauth_server_to_server.postman_environment.json
Wählen Sie in Postman Ihre Umgebung im Dropdown-Menü aus.
Wählen Sie das Symbol aus, um die Umgebungsvariablen anzuzeigen:

Sandbox-Name und Mandanten-ID hinzufügen

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

Öffnen Sie in Postman die Umgebungsvariablen.
Wählen Sie den Link Bearbeiten rechts neben dem Umgebungsnamen aus.
Geben Sie im Feld Neue Variable hinzufügen den Wert SANDBOX_NAME ein.
Geben Sie in beide Wertfelder luma-tutorial ein, den Namen, 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.
Geben Sie im Feld Neue Variable hinzufügen den Wert TENANT_ID ein.
Wechseln Sie zu Ihrem Webbrowser und suchen Sie die Mandantenkennung Ihres Unternehmens, indem Sie zur Experience Platform-Oberfläche navigieren und den Teil der URL nach dem @-Zeichen extrahieren. Beispielsweise ist meine Mandanten-ID techmarketingdemos, Ihre ist jedoch anders:
Kopieren Sie diesen Wert und kehren Sie zum Bildschirm Postman Umgebungen verwalten zurück.
Fügen Sie Ihre Mandanten-ID in beide Wertfelder ein.
Geben Sie im Feld Neue Variable hinzufügen den Wert CONTAINER_ID ein.

Geben Sie global in beide Wertfelder ein

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

Wählen Sie Speichern aus.

API-Aufrufe erstellen

Zugriffstoken abrufen

Adobe bietet einen umfangreichen Satz von Postman Sammlungen, mit denen Sie die Experience Platform-API erkunden können. Diese Sammlungen befinden sich im GitHub-Repository für Adobe Experience Platform Postman-Beispiele🔗. Sie sollten dieses Repo mit einem Lesezeichen versehen, da Sie es in diesem Tutorial und später bei der Implementierung von 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 Methode, um ein Zugriffstoken aus Postman abzurufen.

So generieren Sie das Zugriffstoken:

Laden Sie die Sammlung der Identity Management-Dienst-APIs in Ihren Ordner Luma Tutorial Assets herunter
Importieren der Sammlung in Postman
Wählen Sie die Anfrage oAuth: Request Access Token und wählen Sie Send aus.
Sie sollten eine 200 OK -Antwort mit einem Zugriffstoken in der Antwort erhalten
Das Zugriffstoken sollte automatisch als Umgebungsvariable ACCESS_TOKEN Ihrer Postman -Umgebung gespeichert werden.

Interagieren mit einer Platform-API

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:

Laden Sie die Schema Registry-API-Sammlung in Ihren Luma Tutorial Assets -Ordner herunter
Importieren in Postman
Öffnen Sie Schema Registry-API > Schemas > Listenschemas
Sehen Sie sich die Registerkarten Parameter und Kopfzeilen an und beachten Sie, wie sie einige der zuvor eingegebenen Umgebungsvariablen enthalten.
Beachten Sie, dass das Feld Kopfzeilen > Wert akzeptieren auf application/vnd.adobe.xed-id+json festgelegt ist. Für die Schema Registry-APIs ist einer der angegebenen Accept-Kopfzeilenwerte erforderlich, die verschiedene Formate in der Antwort bereitstellen.
Wählen Sie Senden aus, um Ihren ersten Platform-API-Aufruf durchzuführen!

Hoffentlich haben Sie eine erfolgreiche 200 OK -Antwort mit einer Liste der verfügbaren von Adobe bereitgestellten XDM-Schemas in Ihrer Sandbox erhalten, 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 "Problem protokollieren"zu können.

Wenn Sie Ihre Plattformberechtigungen, Sandbox und Postman eingerichtet haben, können Sie Modelldaten in Schemata modellieren!

recommendation-more-help

513160b6-bf42-4c58-abdd-4f817b1cccad