Guida dell’API di Identity Service
Adobe Experience Platform Identity Service gestisce l'identificazione dei clienti in tempo reale, tra dispositivi e canali diversi, in quello che viene definito un grafico delle identità in Adobe Experience Platform.
Introduzione
Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
- Identity Service: risolve la sfida fondamentale posta dalla frammentazione dei dati del profilo cliente. Ciò avviene collegando le identità tra dispositivi e sistemi in cui i clienti interagiscono con il tuo marchio.
- Real-Time Customer Profile: fornisce un profilo consumer unificato in tempo reale basato su dati aggregati provenienti da più origini.
- Experience Data Model (XDM): framework standardizzato tramite il quale Platform organizza i dati sull'esperienza del cliente.
Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere o avere a disposizione per effettuare correttamente chiamate all'API Identity Service.
Lettura delle chiamate API di esempio
Questa guida fornisce esempi di chiamate API per illustrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito un codice JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione su come leggere chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform.
Raccogliere i valori per le intestazioni richieste
Per effettuare chiamate alle API Platform, devi prima completare l'esercitazione di autenticazione. Completando il tutorial sull’autenticazione si ottengono i valori per ciascuna delle intestazioni richieste in tutte le chiamate API di Experience Platform, come mostrato di seguito:
- Autorizzazione: Bearer
{ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
Tutte le risorse in Experience Platform sono isolate in specifiche sandbox virtuali. Tutte le richieste alle API Platform richiedono un'intestazione che specifichi il nome della sandbox in cui verrà eseguita l'operazione:
- x-sandbox-name:
{SANDBOX_NAME}
Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un’intestazione aggiuntiva:
- Content-Type: application/json
Indirizzamento basato su regione
L'API Identity Service utilizza endpoint specifici della regione che richiedono l'inclusione di un {REGION} come parte del percorso della richiesta. Durante il provisioning dell’organizzazione, un’area viene determinata e memorizzata nel profilo dell’organizzazione. L'utilizzo dell'area corretta con ogni endpoint assicura che tutte le richieste effettuate utilizzando l'API Identity Service vengano instradate all'area appropriata.
Al momento sono presenti due aree supportate dalle API Identity Service: VA7 e NLD2.
La tabella seguente mostra alcuni percorsi di esempio che utilizzano le regioni:
Se non riesci a individuare l’area geografica all’interno del profilo organizzazione, contatta l’amministratore di sistema per assistenza.
Utilizzo dell'API Identity Service
I parametri di identità utilizzati in questi servizi possono essere espressi in due modi: composito o XID.
Le identità composite sono costrutti che includono sia il valore ID che lo spazio dei nomi. Quando si utilizzano identità composite, lo spazio dei nomi può essere fornito da un nome (namespace.code) o da un ID (namespace.id).
Quando un'identità viene resa persistente, Identity Service genera e assegna un ID a tale identità, denominato ID nativo, o XID. Tutte le varianti di Cluster e Mapping API supportano sia le identità composite che XID nelle richieste e nelle risposte. Uno dei parametri è obbligatorio - xid o la combinazione di [ns o nsid] e id per utilizzare queste API.
Per limitare il payload nelle risposte, le API adattano le loro risposte al tipo di costrutto di identità utilizzato. Cioè, se passi XID le tue risposte avranno XID, se passi identità composite, la risposta seguirà la struttura utilizzata nella richiesta.
Gli esempi in questo documento non descrivono la funzionalità completa dell'API Identity Service. Per l'API completa, vedere il Riferimento API Swagger.
Passaggi successivi
Ora che hai raccolto le credenziali richieste, puoi continuare a leggere il resto della guida per sviluppatori. Ogni sezione fornisce informazioni importanti sugli endpoint e illustra esempi di chiamate API per l’esecuzione di operazioni CRUD. Ogni chiamata include il formato API generale, una richiesta di esempio che mostra le intestazioni richieste e i payload formattati correttamente, e una risposta di esempio per una chiamata di successo.