Documentazione Experience Platform Panoramica di Experience Platform

Autenticazione e accesso alle API di Experience Platform

Ultimo aggiornamento: 5 maggio 2025

Argomenti:
API

Creato per:

Sviluppatore

Questo documento fornisce un tutorial dettagliato per accedere a un account sviluppatore Adobe Experience Platform per effettuare chiamate alle API di Experience Platform. Al termine di questa esercitazione, avrai generato o raccolto le seguenti credenziali, necessarie come intestazioni in tutte le chiamate API di Experience Platform:

{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}

TIP

Oltre alle tre credenziali di cui sopra, molte API di Experience Platform richiedono anche un {SANDBOX_NAME} valido da fornire come intestazione. Per ulteriori informazioni sulle sandbox e sulla documentazione dell'endpoint di gestione sandbox, consulta la panoramica sulle sandbox.

Per mantenere la sicurezza delle applicazioni e degli utenti, tutte le richieste alle API di Experience Platform devono essere autenticate e autorizzate utilizzando standard come OAuth.

Questo tutorial illustra come raccogliere le credenziali necessarie per autenticare le chiamate API di Experience Platform, come descritto nel diagramma di flusso seguente. È possibile raccogliere la maggior parte delle credenziali richieste nella configurazione iniziale una tantum. Il token di accesso, tuttavia, deve essere aggiornato ogni 24 ore.

Requisiti del flusso di autenticazione per linstallazione iniziale una tantum e per ogni sessione successiva.

Prerequisiti

Per effettuare correttamente le chiamate alle API di Experience Platform, è necessario disporre dei seguenti elementi:

Organizzazione con accesso a Adobe Experience Platform.
Un amministratore di Admin Console che può aggiungerti come sviluppatore e utente per un profilo di prodotto.
Un amministratore di sistema Experience Platform che può concederti i controlli di accesso basati su attributi necessari per eseguire operazioni di lettura o scrittura su parti diverse di Experience Platform tramite API.

Per completare questa esercitazione è necessario disporre anche di un Adobe ID. Se non disponi di un’Adobe ID, puoi crearne una seguendo questi passaggi:

Vai a Adobe Developer Console.
Selezionare Crea un nuovo account.
Completa il processo di registrazione.

Accesso utente e sviluppatore per Experience Platform

Prima di creare integrazioni su Adobe Developer Console, il tuo account deve disporre delle autorizzazioni per sviluppatori e utenti per un profilo di prodotto Experience Platform in Adobe Admin Console.

Accesso per sviluppatori

Contatta un amministratore Admin Console della tua organizzazione per aggiungerti come sviluppatore a un profilo di prodotto Experience Platform. Per istruzioni specifiche su come gestire l'accesso degli sviluppatori per i profili di prodotto, consulta la documentazione di Admin Console.

Una volta assegnati come sviluppatori, puoi iniziare a creare integrazioni in Adobe Developer Console. Queste integrazioni sono una pipeline da app e servizi esterni alle API di Adobe.

Ottenere l’accesso utente

L’amministratore di Admin Console deve anche aggiungere te come utente allo stesso profilo di prodotto. Con l’accesso utente, puoi visualizzare nell’interfaccia utente il risultato delle operazioni API eseguite.

Per ulteriori informazioni, consulta la guida sulla gestione dei gruppi di utenti in Admin Console🔗.

Generare una chiave API (ID client) e un ID organizzazione

NOTE

Se stai seguendo questo documento dalla guida API di Privacy Service, ora puoi tornare a tale guida per generare le credenziali di accesso univoche per Privacy Service.

Dopo aver ottenuto l'accesso utente e sviluppatore ad Experience Platform tramite Admin Console, il passaggio successivo consiste nel generare le credenziali di {ORG_ID} e {API_KEY} in Adobe Developer Console. Queste credenziali devono essere generate solo una volta e possono essere riutilizzate nelle chiamate API future di Experience Platform.

TIP

Invece di passare a Developer Console, puoi ottenere tutte le credenziali di autenticazione necessarie per utilizzare le API di Experience Platform direttamente dalle pagine della documentazione di riferimento API. Ulteriori informazioni sulla nuova funzionalità.

Aggiungere Experience Platform a un progetto

Vai a Adobe Developer Console e accedi con il tuo Adobe ID. Quindi, segui i passaggi descritti nel tutorial su creazione di un progetto vuoto nella documentazione di Adobe Developer Console.

Dopo aver creato un nuovo progetto, seleziona Aggiungi API nella schermata Panoramica progetto.

TIP

Se disponi del provisioning per più organizzazioni, utilizza il selettore organizzazione nell’angolo superiore destro dell’interfaccia per assicurarti di essere nell’organizzazione necessaria.

Schermata Developer Console con lopzione Aggiungi API evidenziata.

Viene visualizzata la schermata Add an API (Aggiungi un’API). Seleziona l'icona del prodotto per Adobe Experience Platform, quindi scegli Experience Platform API prima di selezionare Next.

Selezionare lAPI Experience Platform nella schermata Aggiungi unAPI.

TIP

Seleziona l'opzione Visualizza documenti per passare in una finestra del browser separata alla documentazione di riferimento API di Experience Platform completa.

Seleziona il tipo di autenticazione da server a server OAuth

Quindi, seleziona il tipo di autenticazione OAuth Server-to-Server per generare i token di accesso e accedere all'API di Experience Platform. Assegna alle credenziali un nome significativo nel campo di testo Nome credenziali prima di selezionare Successivo.

IMPORTANT

Il metodo OAuth Server-to-Server è l'unico metodo di generazione di token supportato per gli spostamenti in avanti. Il metodo Service Account (JWT) precedentemente supportato è obsoleto e non può essere selezionato per nuove integrazioni. Anche se le integrazioni esistenti che utilizzano il metodo di autenticazione JWT continueranno a funzionare fino al 30 giugno 2025, Adobe consiglia vivamente di migrare le integrazioni esistenti al nuovo metodo OAuth Server-to-Server prima di tale data. Ulteriori informazioni nella sezione ObsoletoGenera un token Web JSON (JWT).

Selezionare il metodo di autenticazione server-to-server OAuth per lAPI Experience Platform.

Selezionare i profili di prodotto per l’integrazione

Nella schermata Configura API, seleziona AEP-Default-All-Users insieme agli eventuali profili di prodotto aggiuntivi a cui desideri accedere.

IMPORTANT

Per accedere a determinate funzioni di Experience Platform, è necessario disporre anche di un amministratore di sistema che conceda le autorizzazioni di controllo dell’accesso basate su attributi necessarie. Ulteriori informazioni nella sezione Ottenere le autorizzazioni di controllo dell'accesso basate su attributi necessarie.

Seleziona i profili di prodotto per la tua integrazione.

Seleziona Salva API configurata quando sei pronto.

Una descrizione dettagliata dei passaggi descritti in precedenza per impostare un’integrazione con l’API di Experience Platform è disponibile anche nel tutorial video seguente:

video poster

https://video.tv.adobe.com/v/36258/?learn=on&captions=ita

Raccogli le credenziali

Una volta aggiunta l'API al progetto, nella pagina OAuth Server-to-Server per il progetto vengono visualizzate le credenziali seguenti, necessarie in tutte le chiamate alle API di Experience Platform:

Informazioni sullintegrazione dopo laggiunta di unAPI in Developer Console.

{API_KEY} (ID client)
{ORG_ID} (ID organizzazione)

Generare un token di accesso

Il passaggio successivo consiste nel generare una credenziale {ACCESS_TOKEN} da utilizzare nelle chiamate API di Experience Platform. A differenza dei valori per {API_KEY} e {ORG_ID}, è necessario generare un nuovo token ogni 24 ore per continuare a utilizzare le API di Experience Platform. Seleziona Genera token di accesso che genera il token di accesso, come illustrato di seguito.

Mostra come generare il token di accesso

TIP

Puoi inoltre utilizzare un ambiente e una raccolta Postman per generare i token di accesso. Per ulteriori informazioni, leggere la sezione relativa all'utilizzo di Postman per l'autenticazione e il test delle chiamate API.

Crea e recupera le credenziali di autenticazione direttamente nella documentazione di riferimento dell’API

A partire dalla versione di novembre 2024 di Experience Platform, è possibile ottenere le credenziali per utilizzare le API di Experience Platform direttamente dalle pagine di riferimento API, senza dover passare a Developer Console. Visualizza l'esempio seguente dalla pagina Destinazioni dell'API del servizio di flusso.

La funzionalità di recupero delle credenziali è evidenziata nella parte superiore di una pagina di riferimento API.

Per ottenere le credenziali per chiamare le API Experience Platform, passa a una pagina di riferimento API Experience Platform e seleziona Accedi nella parte superiore della pagina. Accedi con il tuo account personale o account aziendale o scolastico.

Dopo l'accesso, selezionare Crea nuova credenziale per creare un nuovo set di credenziali per accedere alle API di Experience Platform.

Crea nuove credenziali per accedere alle API di Experience Platform.

Quindi, utilizza il selettore a discesa per aprire la finestra delle credenziali, generare un token di accesso e ottenere la chiave API e l’ID organizzazione. Copia le credenziali nei blocchi Prova nelle pagine di riferimento API per iniziare a lavorare con le API di Experience Platform.

Utilizzare il selettore a discesa per visualizzare le credenziali e generare un token di accesso.

TIP

Il blocco delle credenziali nella parte superiore della pagina rimane visualizzato quando navighi tra diverse pagine di endpoint nella documentazione di riferimento API di Experience Platform.

Deprecato genera un token web JSON (JWT)

WARNING

Il metodo JWT per generare i token di accesso è stato dichiarato obsoleto. Tutte le nuove integrazioni devono essere create utilizzando il metodo di autenticazione server-to-server OAuth. Per continuare a funzionare, Adobe richiede anche la migrazione delle integrazioni esistenti al metodo OAuth entro il 30 giugno 2025. Leggi la seguente documentazione importante:

Visualizza informazioni obsolete

Il passaggio successivo consiste nel generare un token web JSON (JWT) in base alle credenziali del tuo account. Questo valore viene utilizzato per generare le credenziali {ACCESS_TOKEN} da utilizzare nelle chiamate API di Experience Platform, che devono essere rigenerate ogni 24 ore.

IMPORTANT

Ai fini di questa esercitazione, i passaggi seguenti descrivono come generare un JWT in Developer Console. Tuttavia, questo metodo di generazione dovrebbe essere utilizzato solo a fini di prova e valutazione.

Per un uso regolare, il JWT deve essere generato automaticamente. Per ulteriori informazioni su come generare JWT a livello di programmazione, consulta la guida all'autenticazione dell'account di servizio su Adobe Developer.

Seleziona Account di servizio (JWT) nel menu di navigazione a sinistra, quindi seleziona Genera JWT.

Nella casella di testo fornita in Genera JWT personalizzato, incolla il contenuto della chiave privata generata in precedenza durante l'aggiunta dell'API Experience Platform all'account del servizio. Quindi, seleziona Genera token.

La pagina viene aggiornata per mostrare il JWT generato, insieme a un comando cURL di esempio che consente di generare un token di accesso. Ai fini di questa esercitazione, seleziona Copia accanto a JWT generato per copiare il token negli Appunti.

Generare un token di accesso

Dopo aver generato un JWT, puoi utilizzarlo in una chiamata API per generare il tuo {ACCESS_TOKEN}. A differenza dei valori per {API_KEY} e {ORG_ID}, è necessario generare un nuovo token ogni 24 ore per continuare a utilizzare le API di Experience Platform.

Richiesta

La richiesta seguente genera un nuovo {ACCESS_TOKEN} in base alle credenziali fornite nel payload. Questo endpoint accetta solo i dati del modulo come payload, pertanto deve ricevere un'intestazione Content-Type di multipart/form-data.

curl -X POST https://ims-na1.adobelogin.com/ims/exchange/jwt \
  -H 'Content-Type: multipart/form-data' \
  -F 'client_id={API_KEY}' \
  -F 'client_secret={SECRET}' \
  -F 'jwt_token={JWT}'

Proprietà

Descrizione

{API_KEY}

{API_KEY} (ID client) recuperato in un passaggio precedente.

{SECRET}

Il segreto client recuperato in un passaggio precedente.

{JWT}

Il JWT generato in un passaggio precedente.

NOTE

Puoi utilizzare la stessa chiave API, lo stesso segreto client e lo stesso JWT per generare un nuovo token di accesso per ogni sessione. Questo consente di automatizzare la generazione dei token di accesso nelle applicazioni.

Risposta

{
  "token_type": "bearer",
  "access_token": "{ACCESS_TOKEN}",
  "expires_in": 86399992
}

Proprietà

Descrizione

token_type

Il tipo of token restituito. Per i token di accesso, questo valore è sempre bearer.

access_token

{ACCESS_TOKEN} generato. Questo valore, con prefisso Bearer, è obbligatorio come intestazione Authentication per tutte le chiamate API di Experience Platform.

expires_in

Il numero di millisecondi rimanenti fino alla scadenza del token di accesso. Quando questo valore raggiunge 0, è necessario generare un nuovo token di accesso per continuare a utilizzare le API di Experience Platform.

Verifica credenziali di accesso

Dopo aver raccolto tutte e tre le credenziali richieste (token di accesso, chiave API e ID organizzazione), puoi provare ad effettuare la seguente chiamata API. Questa chiamata elenca tutte le classi standard Experience Data Model (XDM) disponibili per la tua organizzazione. Importa ed esegui la chiamata in Postman.

recommendation-more-help

Richiesta

curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
  -H 'x-api-key: {{API_KEY}}' \
  -H 'x-gw-ims-org-id: {{ORG_ID}}'

Risposta

Se la risposta è simile a quella mostrata di seguito, le credenziali sono valide e funzionanti. (La risposta è stata troncata per motivi di spazio).

{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

IMPORTANT

Anche se la chiamata precedente è sufficiente per testare le credenziali di accesso, non sarà possibile accedere a o modificare diverse risorse senza disporre delle autorizzazioni di controllo dell’accesso basate su attributi corretti. Ulteriori informazioni sono disponibili nella sezione Ottenere le autorizzazioni di controllo dell'accesso basate su attributi necessarie.

Ottenere le autorizzazioni di controllo dell'accesso basate su attributi necessarie

Per accedere a o modificare diverse risorse all’interno di Experience Platform, devi disporre delle autorizzazioni di controllo di accesso appropriate. Gli amministratori di sistema possono concederti le autorizzazioni necessarie. Ulteriori informazioni nella sezione sulla gestione delle credenziali API per un ruolo.

Informazioni dettagliate su come un amministratore di sistema può concedere le autorizzazioni necessarie per accedere alle risorse di Experience Platform tramite l’API sono disponibili anche nel tutorial video seguente:

video poster

https://video.tv.adobe.com/v/36258/?learn=on&t=159&captions=ita

Utilizzare Postman per autenticare e testare le chiamate API

Postman è uno strumento popolare che consente agli sviluppatori di esplorare e testare le API RESTful. Puoi utilizzare le raccolte e gli ambienti Experience Platform Postman per velocizzare il tuo lavoro con le API Experience Platform. Ulteriori informazioni sull'utilizzo di Postman in Experience Platform e sulla guida introduttiva alle raccolte e agli ambienti.

Informazioni dettagliate sull’utilizzo di Postman con raccolte e ambienti Experience Platform sono disponibili anche nei tutorial video seguenti:

Scarica e importa un ambiente Postman da utilizzare con le API di Experience Platform

video poster

https://video.tv.adobe.com/v/36258/?learn=on&t=106&captions=ita

Utilizzare una raccolta Postman per generare token di accesso

Scarica la raccolta Postman di Identity Management Service e guarda il video seguente per scoprire come generare i token di accesso.

video poster

https://video.tv.adobe.com/v/39133/?learn=on&captions=ita

Scarica raccolte Postman API di Experience Platform e interagisce con le API

video poster

https://video.tv.adobe.com/v/39132/?learn=on&captions=ita

Amministratori di sistema: concedere agli sviluppatori e al controllo dell’accesso API autorizzazioni Experience Platform

Prima di poter creare integrazioni su Adobe Developer Console, il tuo account deve disporre di autorizzazioni per sviluppatori e utenti per un profilo di prodotto Experience Platform.

NOTE

Solo gli amministratori di sistema possono visualizzare e gestire le credenziali API in Autorizzazioni.

Aggiungere sviluppatori al profilo di prodotto

Passa a Admin Console e accedi con il tuo Adobe ID.

Seleziona Prodotti dalla barra di navigazione, quindi seleziona Adobe Experience Platform dall'elenco dei prodotti.

Pagina prodotti in Adobe Admin Console con il prodotto Adobe Experience Platform evidenziato.

Dalla scheda Profili di prodotto, seleziona AEP-Default-All-Users. In alternativa, utilizza la barra di ricerca per cercare il profilo di prodotto inserendo il nome.

La pagina dei profili di prodotto con la barra di ricerca e il prodotto AEP-Default-All-Users evidenziato.

Seleziona la scheda Sviluppatori, quindi seleziona Aggiungi sviluppatore.

Viene visualizzata la scheda Sviluppatori con lopzione Aggiungi sviluppatori evidenziata,

Viene visualizzata la finestra di dialogo Aggiungi sviluppatori. Immetti Email o nome utente dello sviluppatore. Indirizzo e-mail o nome utente valido visualizza i dettagli dello sviluppatore. Seleziona Salva.

La finestra di dialogo Aggiungi sviluppatori con le informazioni per gli sviluppatori è stata compilata ed è stata evidenziata lopzione Salva.

Lo sviluppatore è stato aggiunto correttamente e viene visualizzato nella scheda Sviluppatori.

Nella scheda Sviluppatori viene visualizzato lelenco di tutti gli sviluppatori aggiunti con lo sviluppatore appena aggiunto evidenziato.

Assegnare le credenziali API a un ruolo

NOTE

Solo un amministratore di sistema può assegnare le API ai ruoli nell’interfaccia utente di Experience Platform.

Per utilizzare ed eseguire operazioni sulle API di Experience Platform, un amministratore di sistema deve aggiungere le credenziali API oltre al set di autorizzazioni assegnato a un ruolo. Ulteriori informazioni nella sezione sulla gestione delle credenziali API per un ruolo.

Una descrizione dettagliata dei passaggi descritti in precedenza per aggiungere sviluppatori ai profili di prodotto e assegnare API ai ruoli è disponibile anche nel tutorial video seguente:

video poster

https://video.tv.adobe.com/v/3446406/?learn=on&captions=ita

Risorse aggiuntive

Per ulteriori informazioni sulle API di Experience Platform, consulta le risorse aggiuntive elencate di seguito

Autentica e accedi alla pagina dei video tutorial sulle API di Experience Platform
Raccolta Postman del servizio Identity Management per la generazione dei token di accesso
Raccolte Postman API Experience Platform

Passaggi successivi

Una volta letto questo documento, hai raccolto e verificato correttamente le credenziali di accesso per le API di Experience Platform. Ora puoi seguire insieme alle chiamate API di esempio fornite nella documentazione.

Oltre ai valori di autenticazione raccolti in questa esercitazione, molte API di Experience Platform richiedono anche un {SANDBOX_NAME} valido da fornire come intestazione. Per ulteriori informazioni, consulta la panoramica delle sandbox.