Dokumentation Experience Platform Einrichten von Developer Console und Postman

Einrichten der Entwicklerkonsole und Postman

Last update: Fri Jun 23 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:
API

Erstellt für:

Beginner
Intermediate
Developer

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-Anwendungen. Sie greifen damit auf die Experience Platform-API zu. Weitere Informationen finden Sie unter Dokumentation zur Adobe Developer Console

Erstellen Sie auf Ihrem lokalen Computer einen Ordner mit dem Namen Luma Tutorial Assets für Dateien, die im Tutorial verwendet werden.
Öffnen Sie die Adobe Developer-Konsole
Melden Sie sich an und vergewissern Sie sich, dass Sie sich in der richtigen Organisation befinden
Auswählen Neues Projekt erstellen in Schnellstart Menü.
Wählen Sie im neu erstellten Projekt die Projekt bearbeiten button
Ä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)
Wählen Sie Speichern aus
Auswählen API hinzufügen
Filtern der Liste durch Auswahl Adobe Experience Platform
Wählen Sie in der Liste der verfügbaren APIs Experience Platform-API und wählen Sie Nächste.
Auswählen OAuth Server-zu-Server als Berechtigung und wählen Sie Nächste.
Wählen Sie die AEP-Default-All-Users Produktprofil und wählen Sie Konfigurierte API speichern
Jetzt wurde Ihr Entwicklerkonsole-Projekt erstellt!
Im Testen -Abschnitt der Seite, wählen Sie Herunterladen für Postman und wählen Sie OAuth Server-zu-Server zum Herunterladen der Postman Umgebungs-JSON-Datei. Speichern Sie die oauth_server_to_server.postman_environment.json in 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:

Die Name Ihrer API-Anmeldedaten (Credential in Luma Tutorial API Project)
Die Email für technische Konten Ihrer Anmeldedaten (dies hilft dem Systemadministrator, die Anmeldedaten zu finden)

Hier finden Sie die Anweisungen für den Systemadministrator:

Anmelden Adobe Experience Platform
Auswählen Berechtigungen in der linken Navigation, die Sie zum Rollen Bildschirm
Öffnen Sie die Luma Tutorial Platform Rolle
Wählen Sie die API-Anmeldeinformationen tab
Auswählen API-Anmeldeinformationen hinzufügen
Suchen Sie die Credential in Luma Tutorial API Project Berechtigung, mit der Email für technische Konten bereitgestellt vom Tutorial-Teilnehmer, 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 Postman
Öffnen Postman und erstellen Sie einen Arbeitsbereich
Importieren Sie die heruntergeladene JSON-Umgebungsdatei, oauth_server_to_server.postman_environment.json
In Postman, wählen Sie Ihre Umgebung im Dropdown-Menü aus.
Wählen Sie das Symbol aus, um die Umgebungsvariablen anzuzeigen:

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:

In Postman, öffnen Sie die Umgebungsvariablen
Wählen Sie die Bearbeiten Link rechts neben dem Umgebungsnamen
Im Neues Variablenfeld hinzufügen, eingeben SANDBOX_NAME
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.
Im Neues Variablenfeld hinzufügen, eingeben TENANT_ID
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:
Kopieren Sie diesen Wert und kehren Sie zum Postman Bildschirm "Umgebungen verwalten"
Fügen Sie Ihre Mandanten-ID in beide Wertfelder ein.
Im Neues Variablenfeld hinzufügen, eingeben CONTAINER_ID

Eingabe global in beide Wertfelder

note note
NOTE
`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.

Wählen Sie Speichern aus

API-Aufrufe erstellen

Zugriffstoken abrufen

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 Methode, um ein Zugriffstoken aus Postman abzurufen.

So generieren Sie das Zugriffstoken:

Laden Sie die Erfassung von Identity Management Service-APIs auf Luma Tutorial Assets Ordner
Importieren Sie die Sammlung in Postman
Anforderung auswählen oAuth: Zugriffstoken anfordern Anforderung und Auswahl Senden
Sie sollten eine 200 OK Antwort mit einem Zugriffstoken in der Antwort
Das Zugriffstoken sollte automatisch als ACCESS_TOKEN Umgebungsvariable Ihres Postman Umgebung.

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 auf Luma Tutorial Assets Ordner
Importieren in Postman
Öffnen Schema Registry-API > Schemas > Schemas auflisten
Sehen Sie sich die Parameter und Kopfzeilen -Tabs und beachten Sie, dass sie einige der zuvor eingegebenen Umgebungsvariablen enthalten.
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.
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 von der Adobe bereitgestellten XDM-Schemas 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!

recommendation-more-help

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