Einrichten von Developer Console und Postman
In dieser Lektion richten Sie ein Projekt in der Adobe Developer Console ein und laden Postman Sammlungen herunter, damit Sie Platform-APIs verwenden können.
Um die API-Übungen in diesem Tutorial abzuschließen, laden die Postman-App für Ihr Betriebssystem herunter. Für die Verwendung von Experience Platform-APIs ist Postman zwar nicht erforderlich, erleichtert aber API-Workflows. Adobe Experience Platform stellt Dutzende von Postman-Sammlungen bereit, mit denen Sie API-Aufrufe ausführen und lernen können, wie sie funktionieren. Für den Rest dieses Tutorials werden Kenntnisse über Postman vorausgesetzt. Unterstützung erhalten Sie in der Dokumentation zu Postman.
Platform wird API-First erstellt. Auch wenn Schnittstellenoptionen für alle wichtigen Aufgaben vorhanden sind, sollten Sie die Platform-API zu einem späteren Zeitpunkt verwenden. So können Sie beispielsweise Daten aufnehmen, Elemente zwischen Sandboxes verschieben, Routineaufgaben automatisieren oder neue Platform-Funktionen verwenden, bevor die Benutzeroberfläche erstellt wurde.
Datenarchitekten und Dateningenieure müssen die Platform-API möglicherweise außerhalb dieses Tutorials verwenden.
Erforderliche Berechtigungen
In der Lektion Berechtigungen konfigurieren richten Sie alle Zugriffssteuerungen ein, die zum Abschließen 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 in Echtzeit stattfindenden Ereignissen, das Ausführen von Funktionen zur Laufzeit oder das Erstellen von Plug-ins oder App Builder-Programmen. Sie verwenden sie für den Zugriff auf die Experience Platform-API. Weitere Informationen finden Sie in der Dokumentation zu Adobe Developer Console
-
Erstellen Sie auf Ihrem lokalen Computer einen Ordner mit dem Namen
Luma Tutorial Assetsfür die im Tutorial verwendeten Dateien. -
Öffnen Sie die Adobe Developer Console
-
Melden Sie sich an und bestätigen Sie, dass Sie sich in der richtigen Organisation befinden
-
Wählen Neues Projekt erstellen im SchnellstartMenü aus.
-
Klicken Sie im neu erstellten Projekt auf die Schaltfläche Projekt bearbeiten
-
Ändern Sie Projekttitel in
Luma Tutorial API Project(fügen Sie Ihren Namen an das Ende an, wenn mehrere Personen in Ihrem Unternehmen an diesem Tutorial teilnehmen). -
Wählen Sie Speichern
-
Wählen Sie API hinzufügen
-
Filtern Sie die Liste durch Auswahl von Adobe Experience Platform
-
Wählen Sie in der Liste der verfügbaren APIs Experience Platform API und anschließend Weiter aus.
-
Wählen Sie OAuth Server-zu-Server als Berechtigung aus und klicken Sie auf Weiter.
-
Wählen Sie das Produktprofil
AEP-Default-All-Usersund dann Konfigurierte API speichern
-
Jetzt wurde Ihr Developer Console-Projekt erstellt!
-
Wählen Sie Abschnitt " ausprobieren“ der Seite die Option Für Postman herunterladen und wählen Sie dann OAuth Server-zu-Server aus, um die JSON-Datei für die Postman-Umgebung herunterzuladen. Speichern Sie die
oauth_server_to_server.postman_environment.jsonin IhremLuma Tutorial Assets.
Bitten Sie einen Systemadministrator, die API-Anmeldedaten zur Rolle hinzuzufügen
Um die API-Anmeldeinformationen für die Interaktion mit Experience Platform verwenden zu können, muss ein Systemadministrator die API-Anmeldeinformationen der in der vorherigen Lektion erstellten Rolle zuweisen. Wenn Sie kein Systemadministrator sind, senden Sie ihnen:
-
Der Name Ihrer API-Anmeldedaten (
Credential in Luma Tutorial API Project) -
Die E-Mail-Adresse des technischen Kontos Ihrer Anmeldedaten (dies hilft dem Systemadministrator, die Anmeldedaten zu finden)
Im Folgenden finden Sie die Anweisungen für den Systemadministrator:
-
Anmelden bei Adobe Experience Platform
-
Wählen Sie linken Navigationsbereich Berechtigungen“ aus, um zum Bildschirm Rollen zu gelangen
-
Öffnen Sie die
Luma Tutorial PlatformRolle
-
Wählen Sie die Registerkarte API-) aus
-
Wählen Sie API-Anmeldeinformationen hinzufügen
-
Suchen Sie die
Credential in Luma Tutorial API ProjectAnmeldedaten und filtern Sie mit der E-Mail des technischen Kontos, die der Tutorial-Teilnehmer bereitgestellt hat, wenn die Liste lang ist. -
Auswählen der Berechtigung
-
Wählen Sie Speichern
Einrichten von Postman
-
Herunterladen und Installieren von Postman
-
Postman öffnen und einen Arbeitsbereich erstellen
-
Importieren Sie die heruntergeladene JSON-Umgebungsdatei
oauth_server_to_server.postman_environment.json
-
Wählen Sie Postman Ihre Umgebung im Dropdown-Menü aus
-
Wählen Sie das Symbol aus, um die Umgebungsvariablen anzuzeigen:
Sandbox-Namen 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
-
Klicken Sie auf Link Bearbeiten“ rechts neben dem Umgebungsnamen
-
Geben Sie Feld „Neue Variable hinzufügen
SANDBOX_NAMEein -
Geben Sie in beide Wertefelder
luma-tutorialein, 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 Feld „Neue Variable hinzufügen
TENANT_IDein -
Wechseln Sie zu Ihrem Webbrowser und suchen Sie die Mandanten-ID Ihres Unternehmens, indem Sie zur Experience Platform-Benutzeroberfläche wechseln und den Teil der URL extrahieren nach dem @-Zeichen. Meine Mandanten-ID lautet beispielsweise
techmarketingdemos, Ihre jedoch anders:
-
Kopieren Sie diesen Wert und kehren Sie zum Bildschirm Umgebungen Postman verwalten zurück
-
Fügen Sie Ihre Mandanten-ID in beide Wertefelder ein
-
Geben Sie Feld „Neue Variable hinzufügen
CONTAINER_IDein -
Geben Sie
globalin beide Wertefelder einnote note NOTE CONTAINER_IDist ein Feld, dessen Wert wir im Laufe des Tutorials mehrmals ändern. Wennglobalverwendet wird, interagiert die API mit von Adobe bereitgestellten Elementen in Ihrem Platform-Konto. Wenntenantverwendet wird, interagiert die API mit Ihren eigenen benutzerdefinierten Elementen. -
Wählen Sie Speichern
Durchführen von API-Aufrufen
Abrufen eines Zugriffstokens
Adobe bietet einen umfangreichen Satz an Postman, mit denen Sie die Experience Platform-API erkunden können. Diese Sammlungen befinden sich im GitHub-Repository der Adobe Experience Platform Postman-. Sie sollten dieses Repository als Lesezeichen verwenden, 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 Zugriffs-Token aus Postman abzurufen.
So generieren Sie das Zugriffstoken:
-
Laden Sie die Sammlung der Identity Management ServiceAPIs in Ihren
Luma Tutorial AssetsOrdner herunter -
Importieren der Sammlung in Postman
-
Wählen Sie die Anfrage oAuth: Zugriffstoken anfordern und klicken Sie auf Senden
-
Sie sollten in der Antwort eine
200 OKAntwort mit einem Zugriffstoken erhalten
-
Das Zugriffs-Token sollte automatisch als ACCESS_TOKEN-Umgebungsvariable Ihrer Postman gespeichert werden.
Interagieren mit einer Platform-API
Führen wir nun einen Platform-API-Aufruf durch, um zu bestätigen, dass wir alles richtig konfiguriert haben.
Öffnen Sie die Experience Platform Postman Sammlungen in GitHub. Es gibt viele Sammlungen auf dieser Seite für verschiedene Platform-APIs. Ich empfehle dringend, es zu Lesezeichen.
Lassen Sie uns nun unseren ersten API-Aufruf durchführen:
- Laden Sie die Schema Registry-APISammlung in Ihren
Luma Tutorial AssetsOrdner herunter - In Postman importieren
- Öffnen Sie Schema Registry-API > Schemata > Schemata auflisten
- Sehen Sie sich die Parameter und Kopfzeilen an und beachten Sie, wie sie einige der zuvor eingegebenen Umgebungsvariablen enthalten.
- Beachten Sie, dass Feld „Kopfzeilen > Wert akzeptieren auf
application/vnd.adobe.xed-id+jsongesetzt ist. Die Schema Registry-APIs erfordern einen der angegebenen Accept-HeaderWerte, die verschiedene Formate in der Antwort bereitstellen. - Wählen Sie Senden, um Ihren ersten Platform-API-Aufruf durchzuführen!
Wir hoffen, dass Sie eine erfolgreiche 200 OK erhalten haben, die eine Liste der verfügbaren Adobe-bereitgestellten XDM-Schemas in Ihrer Sandbox enthält, wie unten dargestellt.
Wenn Ihr Aufruf nicht erfolgreich war, nehmen Sie sich einen Moment Zeit, um mit den Details zur Fehlerantwort des API-Aufrufs zu debuggen, und überprüfen Sie die oben genannten Schritte. Wenn Sie hängen bleiben, bitten wir Sie um Hilfe im Community-Forum oder verwenden Sie den Link rechts auf dieser Seite, um „ein Problem zu melden“.
Nachdem Sie Platform-Berechtigungen, Sandbox und Postman eingerichtet haben, können Sie Daten in Schemata modellieren!