Questa guida presenta le API di Adobe Customer Journey Analytics (CJA) in particolare per l’estrazione dei dati, soluzioni personalizzate e integrazioni con soluzioni di terze parti. Contiene informazioni sulla configurazione degli accessi, sulle chiavi API e sui test con Postman, nonché un esempio dettagliato di chiamata API e suggerimenti per i nuovi utenti.

Ti avvicini ora alle API e ti chiedi in che modo le API di Adobe Customer Journey Analytics (CJA) possono aiutarti? Niente paura! In questa guida rivolta ai nuovi utenti, ti guideremo attraverso le funzionalità di base, faremo chiarezza sul gergo tecnico e ti aiuteremo a muovere i primi passi nell’emozionante mondo delle API di CJA.

Non sarebbe bello poter accedere ai dati di CJA e analizzarli a livello programmatico, senza operazioni manuali? È esattamente ciò che potrai fare con le API di CJA!

Le API possono essere viste come messaggeri: inviano le tue richieste ai server di Adobe e ti restituiscono i risultati in un pacchetto ordinato.

Configurazione per il successo

Prima di effettuare la prima chiamata API, è necessario configurare correttamente l’accesso e le autorizzazioni. Innanzitutto, assicurati che ti sia stato assegnato il ruolo di Sviluppatore per la tua organizzazione. Quindi, verifica di avere accesso ai profili di prodotto con le autorizzazioni necessarie.

Passaggio 1: ottenere la chiave API
  1. Accedi ad Adobe Developer Console.
  2. Crea un nuovo progetto, aggiungi Customer Journey Analytics API al progetto e seleziona i profili di prodotto richiesti.
  3. Fai clic su Add to Project (Aggiungi al progetto) e aggiungi Adobe Experience Platform API anche al progetto
  4. Una volta completata la configurazione, potrai ottenere tutte le informazioni necessarie nella scheda Credentials (Credenziali) a sinistra.

Di seguito sono riportati i tre parametri di intestazione essenziali per tutte le richieste API.

Assicurati di salvare queste credenziali: ti serviranno per sbloccare la potenza delle API! Per istruzioni più dettagliate, consulta la Guida introduttiva delle API di CJA.

Passaggio 2: testare La configurazione

Un ottimo modo per testare le API senza scrivere codice consiste nell’utilizzare Postman, uno strumento potente e intuitivo. Dopo aver avviato l’applicazione, puoi importare facilmente le credenziali API. Quindi, per verificare che la connessione e l’autenticazione funzionino correttamente, puoi iniziare con semplici richieste GET. È preferibile iniziare il percorso di test delle API con le richieste GET, in quanto sono più sicure e non distruttive: servono infatti solo per recuperare dati dal server, senza apportare alcuna modifica. Altri metodi HTTP come le richieste POST, PUT o DELETE, invece, possono modificare o rimuovere dati dal server e richiedono quindi maggiore attenzione.

Effettuare la prima chiamata API

Iniziamo con qualcosa di semplice: recuperare un elenco di visualizzazioni di dati disponibili nel tuo account CJA.

Esempio: elenco di visualizzazioni di dati

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

Intestazioni:

x-api-key: {API_KEY}

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

Authorization: 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 "Authorization: Bearer {AUTHORIZATION_TOKEN}"

Puoi anche provare queste richieste nella documentazione sugli endpoint dell’API di CJA, con la funzione Try It (Prova). Ecco il collegamento per provare questa richiesta.

Fai clic sul pulsante Try it (Prova) e immetti tutti i parametri obbligatori, che in questo esempio sono i parametri di intestazione di cui sopra. Quindi premi Send (Invia).

Puoi anche personalizzare la richiesta aggiungendo altri parametri. Per un elenco dei parametri, consulta la sezione Query Parameters (Parametri query) di ogni richiesta API nella documentazione delle API di CJA.

Di seguito riportiamo i principali codici delle risposte HTTP che potresti ricevere quando utilizzi le API:

Questi codici di stato forniscono agli sviluppatori informazioni esatte su cosa è successo durante una richiesta API e sono utili per risolvere eventuali problemi.

NOTE
Quando utilizzi la funzione Try it (Prova), assicurati che il token di accesso nel campo Authorization sia preceduto da “Bearer”. Se questo prefisso viene omesso o digitato in modo errato, si verifica un errore 401.

Suggerimenti per chi utilizza per la prima volta le API

  1. Verificare l’accesso: assicurati di disporre dei livelli di autorizzazione appropriati e di far parte dei profili di prodotto corretti. La mancata riuscita delle richieste API è spesso dovuta a diritti di accesso errati.
  2. Testare e testare di nuovo: utilizza la funzione Try it (Prova) nella documentazione degli endpoint API o in Postman per provare le richieste prima di scrivere il codice.
  3. Iniziare in piccolo: inizia con semplici richieste GET, quindi passa alle query POST.
  4. Consultare la documentazione: la documentazione delle API di CJA di Adobe è un alleato prezioso. Consultala regolarmente per verificare la presenza di eventuali aggiornamenti: dopo un aggiornamento importante, infatti, le configurazioni meno recenti potrebbero non funzionare più come previsto.
  5. Fare domande: non esitare a chiedere assistenza alla community Experience League per Adobe Analytics.

All’inizio le API di Adobe CJA potrebbero intimorire, ma con un po’ di pratica sarai presto in grado di automatizzare i flussi di lavoro e ottenere insight preziosi. Quindi, fai il primo passo: accedi, ottieni le tue credenziali e prova una semplice chiamata API. La tua avventura con le API ti attende!

style
article-content-section
5 minuti
style
article-header-section