Autenticazione e accesso all’API di Privacy Service
Creato per:
- Sviluppatore
Questa guida fornisce un’introduzione ai concetti di base che devi conoscere prima di tentare di effettuare chiamate all’API di Adobe Experience Platform Privacy Service.
Prerequisiti
Questa guida richiede una buona conoscenza di Privacy Service e del modo in cui consente di gestire le richieste di accesso ed eliminazione da parte degli interessati (clienti) nelle applicazioni Adobe Experience Cloud.
Per creare le credenziali di accesso per l’API, un amministratore dell’organizzazione deve aver precedentemente configurato i profili di prodotto per Privacy Service in Adobe Admin Console. Il profilo di prodotto assegnato a un’integrazione API determina le autorizzazioni di tale integrazione per accedere alle funzionalità di Privacy Service. Per ulteriori informazioni, consulta la guida sulla gestione delle autorizzazioni di Privacy Service.
Raccogliere i valori per le intestazioni richieste
Per effettuare chiamate all’API Privacy Service, devi prima raccogliere le credenziali di accesso da utilizzare nelle intestazioni richieste:
Authorization: Bearer {ACCESS_TOKEN}x-api-key: {API_KEY}x-gw-ims-org-id: {ORG_ID}
Questi valori vengono generati utilizzando Adobe Developer Console. {ORG_ID} e {API_KEY} devono essere generati una sola volta e possono essere riutilizzati nelle chiamate API future. Tuttavia, {ACCESS_TOKEN} è temporaneo e deve essere rigenerato ogni 24 ore.
I passaggi per generare questi valori sono descritti in dettaglio di seguito.
Configurazione una tantum
Vai a Adobe Developer Console e accedi con il tuo Adobe ID. Quindi, segui i passaggi descritti nel tutorial su come creare un progetto vuoto, nella documentazione di Developer Console.
Dopo aver creato un nuovo progetto, seleziona Aggiungi al progetto e scegli API dal menu a discesa.
Seleziona l’API Privacy Service
Viene visualizzata la schermata Add an API (Aggiungi un’API). Seleziona Experience Cloud per restringere l'elenco delle API disponibili, quindi seleziona la scheda per Privacy Service API prima di selezionare Next.
TIPQuindi, seleziona il tipo di autenticazione per generare token di accesso e accedere all’API Privacy Service.
IMPORTANT
Assegnare autorizzazioni tramite profili di prodotto
Il passaggio finale della configurazione consiste nel selezionare i profili di prodotto da cui questa integrazione erediterà le relative autorizzazioni. Se selezioni più di un profilo, i relativi set di autorizzazioni verranno combinati per l’integrazione.
NOTEAl termine, selezionare Salva API configurata.
Una volta aggiunta l'API al progetto, nella pagina API Privacy Service per il progetto vengono visualizzate le credenziali seguenti, necessarie in tutte le chiamate alle API Privacy Service:
{API_KEY}(ID client){ORG_ID}(ID organizzazione)
Autenticazione per ogni sessione
L'ultima credenziale richiesta da raccogliere è {ACCESS_TOKEN}, utilizzata nell'intestazione Autorizzazione. A differenza dei valori per {API_KEY} e {ORG_ID}, per continuare a utilizzare l'API è necessario generare un nuovo token ogni 24 ore.
In generale, esistono due metodi per generare un token di accesso:
- Genera il token manualmente per il test e lo sviluppo.
- Generazione automatica dei token per le integrazioni API.
Generare manualmente un token
Per generare manualmente un nuovo {ACCESS_TOKEN}, passa a Credenziali > Server-to-Server OAuth e seleziona Genera token di accesso, come illustrato di seguito.
Viene generato un nuovo token di accesso, e un pulsante consente di copiarlo negli Appunti. Questo valore viene utilizzato per l’intestazione Authorization richiesta e deve essere fornito nel formato Bearer {ACCESS_TOKEN}.
Generazione automatica dei token
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 nella guida all'autenticazione API di Experience Platform.
Lettura delle chiamate API di esempio
Ogni guida dell’endpoint fornisce esempi di chiamate API per dimostrare 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 introduttiva per le API di Experience Platform.
Passaggi successivi
Ora che sai quali intestazioni utilizzare, puoi iniziare a effettuare chiamate all’API Privacy Service. Seleziona una delle guide endpoint per iniziare: