Guida introduttiva all’API di Privacy Service

Questa guida fornisce un’introduzione ai concetti di base da conoscere prima di tentare di effettuare chiamate all’API Adobe Experience Platform Privacy Service.

Prerequisiti

Questa guida richiede una buona comprensione Privacy Service e come consente di gestire le richieste di accesso ed eliminazione dalle persone interessate (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 cui dispone l’integrazione per accedere alle funzionalità di Privacy Service. Consulta la guida su gestione delle autorizzazioni di Privacy Service per ulteriori informazioni.

Raccogli i valori delle 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 Console Adobe Developer. Le {ORG_ID} e {API_KEY} deve essere generato solo una volta e può essere riutilizzato nelle chiamate API future. Tuttavia, il tuo {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 a progetto e scegli API dal menu a discesa .

L’opzione API selezionata dalla Aggiungi a progetto a discesa dalla pagina dei dettagli del progetto in Developer Console

Seleziona un’API e genera una coppia di chiavi

Viene visualizzata la schermata Add an API (Aggiungi un’API). Seleziona Experience Cloud per restringere l’elenco delle API disponibili, seleziona la scheda per API Privacy Service prima di selezionare Successivo.

Scheda API di Privacy Service selezionata dall’elenco delle API disponibili

La Configurare l’API viene visualizzata la schermata . Seleziona l’opzione per Generare una coppia di chiavi, quindi seleziona Genera coppia di chiavi.

La Generare una coppia di chiavi opzione selezionata nella Configurare l’API screen

La coppia di chiavi viene generata automaticamente e un file ZIP contenente una chiave privata e un certificato pubblico viene scaricato dal browser (da utilizzare in un passaggio successivo). Seleziona Next (Avanti) per continuare.

La coppia di chiavi generata mostrata nell’interfaccia utente, i cui valori vengono scaricati automaticamente dal browser

Assegnare le autorizzazioni tramite i profili di prodotto

Il passaggio finale di configurazione consiste nel selezionare i profili di prodotto da cui questa integrazione eredita le autorizzazioni. Se selezioni più di un profilo, i relativi set di autorizzazioni verranno combinati per l’integrazione.

NOTA

I profili di prodotto e le autorizzazioni granulari fornite vengono creati e gestiti dagli amministratori tramite Adobe Admin Console. Consulta la guida su Autorizzazioni di Privacy Service per ulteriori informazioni.

Al termine, seleziona Salva API configurata.

Un singolo profilo di prodotto selezionato dall’elenco prima di salvare la configurazione

Una volta aggiunta l’API al progetto, la pagina del progetto viene nuovamente visualizzata nella pagina Panoramica API di Privacy Service pagina. Da qui, scorri verso il basso fino al Account di servizio (JWT) , che fornisce le seguenti credenziali di accesso necessarie in tutte le chiamate all’API di Privacy Service:

  • ID CLIENT: L’ID client è il {API_KEY} che devono essere fornite nella x-api-key intestazione.
  • ORGANIZATION ID: l’ID organizzazione è il valore {ORG_ID} che deve essere utilizzato nell’intestazione x-gw-ims-org-id.

I valori ID client e ID organizzazione visualizzati nella pagina di panoramica del progetto dopo la configurazione dell’API

Autenticazione per ogni sessione

L'ultima credenziale richiesta da raccogliere è la tua {ACCESS_TOKEN}, utilizzato 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:

Generare manualmente un token

Per generare manualmente una nuova {ACCESS_TOKEN}, apri la chiave privata scaricata in precedenza e incolla il suo contenuto nella casella di testo accanto a Genera token di accesso prima di selezionare Genera token.

Il token di accesso generato in precedenza viene incollato nella pagina della panoramica del progetto, con la Genera token pulsante selezionato dopo

Viene generato un nuovo token di accesso, e un pulsante consente di copiarlo negli Appunti. Questo valore viene utilizzato per l'intestazione Autorizzazione richiesta e deve essere fornito nel formato Bearer {ACCESS_TOKEN}.

Token di accesso generato che viene copiato dall’interfaccia utente

Generazione automatica dei token

Puoi generare nuovi token di accesso per i processi automatizzati inviando un JSON Web Token (JWT) tramite una richiesta POST ad Adobe Identity Management Service (IMS). Consulta il documento Developer Console in Autenticazione JWT per i passaggi dettagliati.

Lettura di chiamate API di esempio

Ogni guida agli endpoint fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richiesta formattati correttamente. Viene inoltre fornito un esempio di codice JSON restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione sulle come leggere le chiamate API di esempio nella guida introduttiva per le API di Platform.

Passaggi successivi

Ora che conosci le intestazioni da utilizzare, sei pronto per iniziare a effettuare chiamate all’API di Privacy Service. Seleziona una delle guide dell'endpoint da iniziare:

In questa pagina