In deze handleiding worden Adobe Customer Journey Analytics (CJA)-API's besproken met details over data-extractie, aangepaste oplossingen en integratie van producten van derden. Dit omvat de installatie van toegang, API-sleutels, testen met Postman, een stapsgewijs voorbeeld van een API-aanroep en tips voor nieuwe gebruikers.

Zijn API's nieuw voor u, en vraagt u zich af hoe Adobe Customer Journey Analytics (CJA)-API's handig voor u kunnen zijn? Geen zorgen! In deze beginnersvriendelijke handleiding laten we u de basisprincipes zien, leggen we het jargon uit en helpen we u bij de eerste stappen in de spannende wereld van CJA-API's.

Stel dat het mogelijk was om CJA-data programmatisch te bekijken en te analyseren, zonder handmatige inspanning. Dat is precies wat u met CJA-API's kunt doen!

• Extraheer data efficiënt: stroomlijn data-extractie met API-aanroepen.
• Bouw aangepaste oplossingen: ontwerp en implementeer geautomatiseerde rapporteringspijplijnen die zijn aangepast aan specifieke bedrijfsbehoeften.
• Maak naadloos verbinding: zorg voor een soepele datastroom tussen CJA en applicaties van derden door robuuste integratie.

Zie API's als boodschappers: ze brengen uw verzoeken naar Adobe-servers en brengen de resultaten weer terug in een handig pakketje.

Voorbereiding op succes

Voordat u uw eerste API-aanroep uitvoert, moet u de juiste toegang en machtigingen instellen. Zorg eerst dat u bent toegevoegd als ontwikkelaar voor uw organisatie. Controleer vervolgens of u toegang tot de productprofielen hebt met de vereiste machtigingen.

Stap 1: API-sleutel ophalen

1. Meld u aan bij Adobe Developer Console.
2. Maak een nieuw project, voeg de Customer Journey Analytics-API aan uw project toe en selecteer de vereiste productprofielen.
3. Klik op Aan project toevoegen en voeg Adobe Experience Platform-API ook aan het project toe
4. Zodra de instellingen zijn voltooid, kunt u alle vereiste informatie vinden op het tabblad  Aanmeldingsgegevens aan de linkerkant.

Deze drie essentiële headerparameters zijn vereist voor alle API-verzoeken:

• Toegangstoken – Hiermee hebben alleen bevoegde gebruikers toegang tot de data. Ze worden gegenereerd door te klikken op CTA Toegangstoken genereren, die in de screenshot is gemarkeerd. Dit wordt in het AP-verzoek een parameter voor Autorisatie genoemd
• Client-ID - Dit wordt ook de API-sleutel genoemd, in het API-verzoek x-api-key
• Organisatie-ID - Dit wordt in het API-verzoek x-gw-ims-org-id genoemd

Sla deze aanmeldingsgegevens op. Het zijn onze sleutels om de kracht van de API te ontgrendelen. Gedetailleerdere stapsgewijze instructies vindt u in het gedeelte Aan de slag van de CJA-API.

Stap 2: Installatie testen

Een goede manier om API's te testen zonder code te schrijven is aan de hand van de krachtige en gebruikersvriendelijke tool Postman. Na het starten van de applicatie kunt u eenvoudig API-aanmeldingsgegevens importeren en gaan experimenteren met eenvoudige GET-verzoeken om te controleren of uw verbinding en verificatie goed werken. Het wordt aanbevolen om uw API-testtraject te starten met GET-verzoeken omdat deze als veiliger en niet-destructief worden beschouwd, aangezien ze serverdata alleen maar ophalen zonder wijzigingen aan te brengen. Dit staat in contrast met andere HTTP-methoden zoals POST-, PUT- of DELETE-verzoeken, waarmee data op de server kunnen worden gewijzigd of verwijderd en die daarom met meer voorzichtigheid moeten worden getest.

Eerste API-aanroep doen

Laten we iets simpels doen: een lijst met beschikbare dataweergaven ophalen in uw CJA-account.

Voorbeeld: Lijst met dataweergaven

Eindpunt:
GET https://cja.adobe.io/data/dataviews

Headers:

x-api-key: {API_KEY}

x-gw-ims-org-id: {IMS_ORG_ID}

Toestemming: 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}"

U kunt deze verzoeken ook uitproberen binnen de CJA API-eindpuntdocumentatie met de functie Try It (Uitproberen). Hier is de koppeling om het bovengenoemde verzoek uit te proberen.

Klik gewoon op de CTA Uitproberen en geef alle vereiste parameters op, in dit geval de headerparameters die we hebben besproken, en druk op Verzenden.

U kunt nog meer parameters opnemen om uw verzoek aan te passen. U vindt een lijst met beschikbare parameters onder de sectie Queryparameters voor elk API-verzoek in de CJA-API-documentatie.

Dit zijn de belangrijkste HTTP-responscodes waarmee u te maken krijgt wanneer u met API's werkt:

• 200: Succes – De server heeft het verzoek verwerkt en heeft data geretourneerd
• 404: Niet gevonden – De server kan de gevraagde resource niet vinden
• 500: Interne serverfout – Op de server is een fout opgetreden

Aan de hand van deze statuscodes weten ontwikkelaars precies wat er tijdens een API-verzoek is gebeurd, zodat problemen gemakkelijker kunnen worden opgelost.

Tips voor nieuwe API-gebruikers

1. Toegang controleren: Zorg dat u de juiste toestemmingsniveaus hebt en dat u aan de juiste productprofielen bent toegevoegd. Het ontbreken van de juiste toegang is de meest voorkomende oorzaak van mislukte API-verzoeken
2. Test, test, test: Gebruik de functie Uitproberen in de API-eindpuntdocumentatie of Postman om te experimenteren met verzoeken voordat u code schrijft.
3. Begin klein: Begin met eenvoudige GET-verzoeken en werk verder naar POST-verzoeken.
4. Gebruiksdocumentatie: De CJA API-documentatie van Adobe is uw beste hulp. Controleer regelmatig op updates, omdat oudere configuraties na grote updates soms niet werken zoals verwacht.
5. Vragen stellen: Aarzel niet om contact te leggen met de Experience League Adobe Analytics-community voor hulp.

Werken met Adobe CJA-API's kan in het begin intimiderend lijken, maar met een beetje oefening kunt u al snel workflows automatiseren en inzichten ontdekken. Zet dus de eerste stap: meld u aan, haal aanmeldingsgegevens op en probeer probeer een eenvoudige API-aanroep uit. Uw API-avontuur wacht op u!