Guida dell’API di Privacy Service

Adobe Experience Platform Privacy Service fornisce un’API RESTful e un’interfaccia utente che consentono di gestire (accedere e cancellare) i dati personali delle persone interessate (clienti) nelle applicazioni Adobe Experience Cloud. Privacy Service fornisce inoltre un meccanismo centrale di audit e registrazione che consente di accedere allo stato e ai risultati dei processi che coinvolgono Experience Cloud le applicazioni.

Questa guida illustra come utilizzare l’ API Privacy Service . Per informazioni dettagliate sull'utilizzo dell'interfaccia utente, consulta Panoramica dell'interfaccia utente di Privacy Service. Per un elenco completo di tutti gli endpoint disponibili nell’ API Privacy Service, consulta il riferimento API.

Introduzione

Questa guida richiede una buona comprensione delle seguenti funzioni Experience Platform :

  • Privacy Service: Fornisce un’API RESTful e un’interfaccia utente che consentono di gestire le richieste di accesso e di cancellazione dalle persone interessate (clienti) nelle applicazioni Adobe Experience Cloud.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per effettuare correttamente le chiamate all’API Privacy Service.

Lettura di chiamate API di esempio

Questa esercitazione 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 su come leggere le chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform .

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: {IMS_ORG}

Ciò comporta l’ottenimento delle autorizzazioni per gli sviluppatori per Experience Platform in Adobe Admin Console e la generazione delle credenziali in Adobe Developer Console.

Accesso degli sviluppatori a Experience Platform

Per ottenere l'accesso degli sviluppatori a Platform, segui i passaggi iniziali nell' esercitazione sull'autenticazione Experience Platform. Una volta raggiunto il passaggio "Generate access credentials in Adobe Developer Console" (Genera credenziali di accesso in Developer Console), torna a questa esercitazione per generare le credenziali specifiche di Privacy Service.

Generare le credenziali di accesso

Utilizzando Adobe Developer Console, è necessario generare le tre credenziali di accesso seguenti:

  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}

I {IMS_ORG} e {API_KEY} devono essere generati una sola volta e possono essere riutilizzati in 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 nell’esercitazione 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 .

Viene visualizzata la schermata Add an API (Aggiungi un’API). Seleziona API Privacy Service dall'elenco delle API disponibili prima di selezionare Avanti.

Viene visualizzata la schermata Configura API . Seleziona l'opzione Genera una coppia di chiavi, quindi seleziona Genera una coppia di chiavi nell'angolo in basso a destra.

La coppia di chiavi viene generata automaticamente e un file ZIP contenente una chiave privata e un certificato pubblico viene scaricato nel computer locale (da utilizzare in un passaggio successivo). Seleziona Salva API configurata per completare la configurazione.

Una volta aggiunta l’API al progetto, la pagina del progetto viene nuovamente visualizzata nella pagina Panoramica API di Privacy Service . Da qui, scorri verso il basso fino alla sezione Service Account (JWT) (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 necessario {API_KEY} per deve essere fornito nell’intestazione x-api-key.
  • ID ORGANIZZAZIONE: L'ID organizzazione è il {IMS_ORG} valore che deve essere utilizzato nell'intestazione x-gw-ims-org-id.

Autenticazione per ogni sessione

L’ultima credenziale richiesta da raccogliere è la tua {ACCESS_TOKEN}, utilizzata nell’intestazione Autorizzazione. A differenza dei valori per {API_KEY} e {IMS_ORG}, per continuare a utilizzare le API Platform è necessario generare un nuovo token ogni 24 ore.

Per generare 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.

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}.

Passaggi successivi

Ora che conosci le intestazioni da utilizzare, sei pronto per iniziare a effettuare chiamate all’ API Privacy Service. Il documento sui lavori sulla privacy illustra le varie chiamate API che puoi effettuare utilizzando l'API Privacy Service. Ogni chiamata di esempio include il formato API generale, una richiesta di esempio che mostra le intestazioni richieste e una risposta di esempio.

In questa pagina