Den här guiden handlar om API:erna för Adobe Customer Journey Analytics (CJA) och tar upp dataextrahering, anpassade lösningar och integrering med tredje parter. Den tar upp åtkomstkonfigurationer, API-nycklar, Postman-tester samt ett stegvist exempel på API-anrop och tips för förstagångsanvändare.
Är du ovan vid API:er och undrar hur Adobe Customer Journey Analytics-API:erna kan hjälpa dig? Oroa dig inte! I nybörjarguiden går vi igenom grunderna, lär dig termerna och hjälper dig att ta dina första steg in i den spännande världen av CJA API:er.
Föreställ dig att du kan komma åt och analysera CJA-data programmatiskt utan manuellt arbete. Det är precis vad CJA API:erna gör!
- Extrahera data effektivt: Effektivisera dataextraheringen med API-anrop.
- Bygg anpassade lösningar: Utforma och implementera automatiserade rapportpipelines som är anpassade efter specifika affärsbehov.
- Anslut sömlöst: Aktivera ett smidigt dataflöde mellan CJA och tredjepartsprogram via stabila integreringar.
Tänk på API:er som budbärare – de skickar dina frågor till Adobes servrar och returnerar resultaten i prydliga paket.
Konfigurera för framgång
Innan du gör ditt första API-anrop måste du konfigurera åtkomst och behörigheter. Kontrollera först att du har lagts till som utvecklare i din organisation. Kontrollera sedan att du har tillgång till produktprofilerna och har nödvändiga behörigheter.
Steg 1: Hämta API-nyckeln
- Logga in på Adobe Developer Console.
- Skapa ett nytt projekt och lägg till Customer Journey Analytics API i ditt projekt och välj önskade produktprofiler.
- Klicka på Lägg till i projekt och lägg till Adobe Experience Platform API i projektet
- När konfigurationen är klar kan du hitta all nödvändig information på fliken Autentiseringsuppgifter till vänster.
Här är tre viktiga sidhuvudsparametrar som krävs för alla API-begäranden
- Access Token – det garanterar att bara behöriga användare får åtkomst till data och kan genereras genom att klicka på Generate access token som markeras på skärmbilden. Det kallas Authorization-parametern i API-begäran
- Client ID – kallas även API-nyckel och x-api-key i API-begäran
- Organization ID – kallas för x-gw-ims-org-id i API-begäran
Spara dessa inloggningsuppgifter, de är dina nycklar till att låsa upp API-funktionerna! Mer detaljerade, stegvisa instruktioner finns i avsnittet Komma igång i CJA API.
Steg 2: Testa konfigurationen
Ett bra sätt att testa API:er utan att skriva kod är att använda det kraftfulla och användarvänliga verktyget Postman. När du har startat programmet kan du enkelt importera dina API-autentiseringsuppgifter och börja experimentera med enkla GET-begäranden för att verifiera att anslutningen och autentiseringen fungerar som de ska. Vi rekommenderar att du börjar API-testandet med GET-begäranden. De anses vara säkrare och icke-förstörande eftersom de bara hämtar data från servern utan att göra några ändringar. Andra HTTP-metoder som POST-, PUT- eller DELETE-begäranden kan ändra eller ta bort data på servern och bör därför användas med större försiktighet.
Skapa ditt första API-anrop
Låt oss göra något enkelt: hämta en lista över tillgängliga datavyer på ert CJA-konto.
Exempel: Visa datavyer
Slutpunkt:
GET https://cja.adobe.io/data/dataviews
Sidhuvuden:
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG_ID}
Authorization: Bearer {AUTHORIZATION_TOKEN}
CURL Request:
curl -X GET "https://cja.adobe.io/data/dataviewsexpansion=name%2Cowner%2Corganization%2Cdescription"\
-H "x-api-key: {API_KEY}" \
-H "x-gw-ims-org-id: {IMS_ORG_ID}" \
-H "Authorization: Bearer {AUTHORIZATION_TOKEN}"
Du kan också testa dessa förfrågningar i CJA API-slutpunktsdokumentationen med funktionen Try It. Här är länken till att prova begäran ovan.
Klicka bara på Try It och ange alla obligatoriska parametrar, i det här fallet sidhuvudsparametrarna som vi diskuterade och tryck på Send.
Du kan även inkludera andra parametrar om du vill anpassa din begäran. En lista med tillgängliga parametrar finns i avsnittet Query Parameters för varje API-begäran i CJA API-dokumentationen.
Här är de viktigaste HTTP-svarskoderna som du kommer att stöta på när du arbetar med API
- 200: Klart – servern bearbetade begäran och returnerade data
- 404: Hittades inte – servern kunde inte hitta den begärda resursen
- 500: Internt serverfel – ett fel uppstod på serversidan
Dessa statuskoder berättar för utvecklarna vad som hände under en API-begäran vilket gör det enklare att felsöka problem.
Tips för API-nybörjare
- Verifiera åtkomst: Kontrollera att du har rätt behörighetsnivåer och att du har lagts till i rätt produktprofiler. Att du saknar åtkomst är den vanligaste orsaken till att API-begäranden misslyckas
- Testa, testa, testa: Använd funktionen Try It i API-slutpunktsdokumentationen eller Postman för att experimentera med olika begäranden innan du skriver kod.
- Börja med något enkelt: Börja med enkla GET-begäranden och arbeta upp till POST-begäranden.
- Använd dokumentationen: Adobes CJA API-dokumentation är din bästa vän. Sök regelbundet efter uppdateringar eftersom äldre konfigurationer kanske inte fungerar som förväntat efter större uppdateringar.
- Ställ frågor: Tveka inte att kontakta Experience League Adobe Analytics-communityn om du behöver hjälp.
Det kan verka överväldigande att komma igång med Adobe CJA API:erna, men med lite övning kommer du att automatisera arbetsflöden och upptäcka insikter på nolltid. Så ta det första steget – logga in, hämta dina uppgifter och prova ett enkelt API-anrop. Ditt API-äventyr väntar!