Questa guida tratta le API di Adobe Customer Journey Analytics (CJA), illustrando l’estrazione dati, soluzioni personalizzate e integrazione con terze parti. Troverai la configurazione dell’accesso, le chiavi API, i test con Postman, un esempio pratico di chiamata API e suggerimenti utili per chi inizia.
Se è la prima volta che ti avvicini alle API e vuoi capire come le API di Adobe Customer Journey Analytics (CJA) possono aiutarti, sei nel posto giusto! In questa Guida pensata per chi inizia, ti mostreremo i concetti fondamentali, spiegheremo i termini tecnici e ti accompagneremo nei primi passi nel mondo delle API di CJA.
Immagina di poter accedere e analizzare i dati di CJA in modo automatico, senza interventi manuali: è proprio ciò che puoi fare grazie alle API di CJA!
- Estrai dati in modo efficiente: semplifica l’estrazione dati con le chiamate API.
- Crea soluzioni personalizzate: progetta e implementa pipeline di reportistica automatizzata su misura per le tue esigenze aziendali.
- Collega senza interruzioni: abilita un flusso dati fluido tra CJA e applicazioni di terze parti grazie a integrazioni robuste.
Pensa alle API come a dei messaggeri: portano la tua richiesta ai server di Adobe e ti restituiscono i risultati in modo ordinato.
Configura per il successo
Prima di effettuare la tua prima chiamata API, devi impostare correttamente accesso e autorizzazioni. Per prima cosa, assicurati di essere stato aggiunto come sviluppatore per la tua organizzazione. Poi verifica di avere accesso ai profili prodotto con le autorizzazioni necessarie.
Passaggio 1: ottieni la tua chiave API
- Accedi a Adobe Developer Console.
- Crea un nuovo progetto e aggiungi Customer Journey Analytics API al tuo progetto e seleziona i profili prodotto necessari.
- Fai clic su Aggiungi al progetto e aggiungi anche Adobe Experience Platform API al progetto
- Una volta completata la configurazione, puoi trovare tutte le informazioni necessarie nella scheda Credenziali a sinistra.
Ecco i tre parametri di intestazione fondamentali richiesti per tutte le richieste API:
- Token di accesso – Garantisce che solo gli utenti autorizzati possano accedere ai dati e può essere generato facendo clic sulla CTA Genera token di accesso evidenziata nello screenshot. Questo parametro viene chiamato Autorizzazione nella richiesta API.
- Client ID - Conosciuto anche come Chiave API, questo parametro è indicato come x-api-key nella richiesta API.
- Organization ID – Questo parametro è chiamato x-gw-ims-org-id nella richiesta API.
Salva queste credenziali: sono la chiave per sfruttare al massimo la potenza dell’API! Trovi istruzioni dettagliate passo passo nella sezione Guida introduttiva dell’API CJA.
Fase 2: testa la configurazione
Un modo semplice per testare le API senza scrivere codice è utilizzare lo strumento potente e intuitivo Postman. Dopo aver avviato l’applicazione, puoi importare facilmente le credenziali API e iniziare subito a sperimentare con semplici richieste GET per verificare che la connessione e l’autenticazione funzionino correttamente. Ti consigliamo di iniziare i test delle API proprio con le richieste GET, perché sono considerate più sicure e non distruttive: infatti, si limitano a recuperare dati dal server senza modificarli. Al contrario, altri metodi HTTP come POST, PUT o richieste DELETE possono modificare o eliminare dati sul server e vanno quindi testati con maggiore attenzione.
Effettua la tua prima chiamata API
Facciamo qualcosa di semplice: recupera l’elenco delle visualizzazioni dati disponibili nel tuo account CJA.
Esempio: elenco visualizzazioni dati
Endpoint:
GET https://cja.adobe.io/data/dataviews
Intestazioni:
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG_ID}
Autorizzazione: Bearer {AUTHORIZATION_TOKEN}
Richiesta CURL:
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 "Autorizzazione: Bearer {AUTHORIZATION_TOKEN}"
Puoi anche provare queste richieste nella documentazione dell'endpoint API CJA utilizzando la funzione Prova. Ecco il link per provare la richiesta sopra.
Clicca sul CTA Try It e inserisci tutti i parametri obbligatori, in questo caso i parametri di intestazione di cui abbiamo parlato, poi premi Send.
Puoi aggiungere altri parametri per personalizzare la tua richiesta. Trovi l’elenco dei parametri disponibili nella sezione Query Parameters per ogni richiesta API all’interno della documentazione CJA API.
Ecco i principali codici di risposta HTTP che incontrerai lavorando con le API:
- 200: Success — Il server ha elaborato la richiesta e ha restituito i dati
- 404: Not Found — Il server non ha trovato la risorsa richiesta
- 500: Internal Server Error — Si è verificato un errore lato server
Questi codici di stato aiutano gli sviluppatori a capire cosa è successo durante una richiesta API e semplificano la risoluzione dei problemi.
Consigli per chi usa le API per la prima volta
- Verifica l’accesso: Assicurati di avere i livelli di autorizzazione corretti e di essere stato aggiunto ai profili prodotto giusti. L’accesso non corretto è la causa più comune delle richieste API non riuscite
- Fai test su test: Usa la funzione Prova nella documentazione dell’endpoint API o in Postman per sperimentare con le richieste prima di scrivere codice.
- Parti in piccolo: Inizia con semplici richieste GET e passa gradualmente alle query POST.
- Usa la Documentazione: La Documentazione API di CJA di Adobe è la tua migliore alleata. Controlla regolarmente gli aggiornamenti, perché le configurazioni precedenti potrebbero non funzionare come previsto dopo aggiornamenti importanti.
- Fai domande: Non esitare a chiedere supporto alla Community Experience League Adobe Analytics.
Iniziare con le API di Adobe CJA può sembrare complicato all’inizio, ma con un po’ di pratica automatizzerai i flussi di lavoro e scoprirai nuovi insight in breve tempo. Fai il primo passo: accedi, recupera le tue credenziali e prova una semplice chiamata API. La tua avventura con le API sta per cominciare!