Konfigurera Developer Console och Postman
I den här lektionen ska du konfigurera ett projekt i Adobe Developer Console och hämta Postman-samlingar så att du kan börja använda plattforms-API:er.
För att kunna slutföra API-övningarna i den här självstudiekursen hämtar du Postman-appen för ditt operativsystem. Krävs inte för att kunna använda Experience Platform API:er, men Postman gör API-arbetsflöden enklare och Adobe Experience Platform tillhandahåller dussintals Postman-samlingar som hjälper dig att köra API-anrop och lära dig hur de fungerar. Resten av den här självstudiekursen bygger på en del praktiska kunskaper i Postman. Mer information finns i Postman-dokumentationen.
Plattformen är byggd för API. Även om det finns gränssnittsalternativ för alla viktiga uppgifter kan det vara bra att använda plattforms-API:t någon gång. Om du till exempel vill importera data flyttar du objekt mellan sandlådor, automatiserar rutinuppgifter eller använder nya plattformsfunktioner innan användargränssnittet har skapats.
Dataarkitekter och datatekniker kan behöva använda Platform API utanför den här självstudiekursen.
Behörigheter krävs
I lektionen Konfigurera behörigheter ställer du in alla åtkomstkontroller som krävs för att slutföra lektionen.
Konfigurera Adobe Developer Console
Adobe Developer Console är utvecklarmålet för att få tillgång till Adobe API:er och SDK:er, lyssna på händelser i realtid, köra funktioner i körningsmiljön eller bygga plugin-program eller App Builder-program. Du kommer att använda den för att komma åt Experience Platform API:t. Mer information finns i Adobe Developer Console-dokumentationen
-
Skapa en mapp på den lokala datorn med namnet
Luma Tutorial Assetsför filer som används i självstudiekursen. -
Öppna Adobe Developer Console
-
Logga in och bekräfta att du använder rätt Org
-
Välj Create New Project på menyn Quick Start.
-
I det nyskapade projektet väljer du knappen Edit Project
-
Ändra Project Title till
Luma Tutorial API Project(lägg till ditt namn i slutet om flera personer från ditt företag använder den här självstudiekursen) -
Välj Save
-
Välj Add API
-
Filtrera listan genom att välja Adobe Experience Platform
-
I listan över tillgängliga API:er väljer du Experience Platform API och sedan Next.
-
Välj OAuth Server-to-Server som autentiseringsuppgift och välj Next.
-
Välj produktprofilen
AEP-Default-All-Usersoch välj Save Configured API
-
Nu har ditt Developer Console-projekt skapats!
-
I avsnittet Try it out på sidan väljer du Download for Postman och sedan OAuth Server-to-Server för att hämta Postman JSON-miljöfilen. Spara
oauth_server_to_server.postman_environment.jsoni mappenLuma Tutorial Assets.
Låt en systemadministratör lägga till API-autentiseringsuppgifterna i rollen
Om du vill använda API-autentiseringsuppgifterna för att interagera med Experience Platform måste du ha en systemadministratör som tilldelar API-autentiseringsuppgifterna till rollen som skapades i den föregående lektionen. Om du inte är systemadministratör skickar du dem:
-
Name för dina API-autentiseringsuppgifter (
Credential in Luma Tutorial API Project) -
Technical Account Email av dina autentiseringsuppgifter (detta hjälper systemadministratören att hitta autentiseringsuppgifterna)
Här följer instruktionerna för systemadministratören:
-
Logga in på Adobe Experience Platform
-
Välj Permissions i den vänstra navigeringen som tar dig till skärmen Roles
-
Öppna rollen
Luma Tutorial Platform
-
Välj fliken API Credentials
-
Välj Add API Credentials
-
Hitta autentiseringsuppgifterna
Credential in Luma Tutorial API Project, filtrera med den Technical Account Email som tillhandahålls av den som deltar i självstudiekursen, om listan är lång -
Välj autentiseringsuppgifter
-
Välj Save
Konfigurera Postman
-
Hämta och installera Postman
-
Öppna Postman och skapa en arbetsyta
-
Importera den hämtade JSON-miljöfilen,
oauth_server_to_server.postman_environment.json
-
I Postman väljer du din miljö i listrutan
-
Markera ikonen om du vill visa miljövariablerna:
Lägg till sandlådenamn och klient-ID
Variablerna SANDBOX_NAME, TENANT_ID och CONTAINER_ID ingår inte i Adobe Developer Console-exporten, så vi lägger till dem manuellt:
-
Öppna Miljövariabler i Postman
-
Markera länken Redigera till höger om miljönamnet
-
I fältet Lägg till ny variabel anger du
SANDBOX_NAME -
I båda värdefälten anger du
luma-tutorial, det namn som vi gav till vår sandlåda i föregående lektion. Om du har använt ett annat namn för sandlådan, till exempel luma-tutorial-igatiusjreilly, måste du använda det värdet. -
I fältet Lägg till ny variabel anger du
TENANT_ID -
Växla till din webbläsare och leta upp ditt företags klientorganisations-ID genom att gå till Experience Platform-gränssnittet och extrahera delen av URL:en efter @-tecknet. Min klient-ID är till exempel
techmarketingdemosmen din är annorlunda:
-
Kopiera det här värdet och gå tillbaka till skärmen Postman Hantera miljöer
-
Klistra in ditt klient-ID i båda värdefälten
-
I fältet Lägg till ny variabel anger du
CONTAINER_ID -
Ange
globali båda värdefältennote note NOTE CONTAINER_IDär ett fält vars värde vi ändrar flera gånger under självstudien. Närglobalanvänds interagerar API med element som tillhandahålls av Adobe i ditt plattformskonto. Närtenantanvänds interagerar API med dina egna anpassade element. -
Välj Spara
Göra API-anrop
Hämta en åtkomsttoken
Adobe har en omfattande uppsättning Postman samlingar som hjälper dig att utforska Experience Platform API. De här samlingarna finns i Adobe Experience Platform Postman Samples GitHub-repo. Du bör skapa ett bokmärke för det här svaret eftersom du kommer att använda det här flera gånger i den här kursen och senare när du implementerar Experience Platform för ditt eget företag.
Den första samlingen fungerar med Adobe Identity Management Service (IMS) API:er. Det är ett bekvämt sätt att hämta en åtkomsttoken inifrån Postman.
Så här skapar du en åtkomsttoken:
-
Hämta samlingen Identity Management Service API:er till din
Luma Tutorial Assets-mapp -
Importera samlingen till Postman
-
Välj begäran Autentisering: Begär åtkomsttoken och välj Skicka
-
Du bör få ett
200 OK-svar med en åtkomsttoken i svaret
-
Åtkomsttoken ska lagras automatiskt som miljövariabeln ACCESS_TOKEN i Postman-miljön.
Interagera med en plattform-API
Låt oss nu ringa ett Platform API-anrop för att bekräfta att vi har konfigurerat allt korrekt.
Öppna Experience Platform Postman samlingarna i GitHub. Det finns många samlingar på den här sidan för olika plattforms-API:er. Jag rekommenderar att du bokmärker det.
Låt oss ringa vårt första API-anrop:
- Hämta API-samlingen för schemaregister till mappen
Luma Tutorial Assets - Importera den till Postman
- Öppna API för schemaregister > Scheman > Lista scheman
- Titta på flikarna Parametrar och Sidhuvuden och se hur de innehåller några av de miljövariabler som vi angav tidigare.
- Observera att fältet Sidhuvuden > Acceptera värde är inställt på
application/vnd.adobe.xed-id+json. API:erna för schemaregister kräver ett av dessa angivna värden för Acceptera sidhuvud som har olika format i svaret. - Välj Skicka för att göra ditt första Platform API-anrop!
Förhoppningsvis har du fått ett 200 OK-svar som innehåller en lista över tillgängliga XDM-scheman som tillhandahålls av Adobe i din sandlåda, enligt bilden nedan.
Om samtalet inte lyckades kan du felsöka med hjälp av felsvarsinformationen för API-anropet och granska stegen ovan. Om du fastnar ber du om hjälp i Community-forumet eller använder länken till höger på den här sidan för att logga ett problem.
Med din plattformsbehörighet, sandlåda och Postman konfigurerad är du redo att modellera data i scheman!