Privacy Service Guida API

Adobe Experience Platform Privacy Service fornisce un'API RESTful e un'interfaccia utente che consentono di gestire (accedere ed eliminare) i dati personali dei tuoi soggetti dati (clienti) tra le applicazioni Adobe Experience Cloud. Privacy Service fornisce inoltre un meccanismo centrale di controllo 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, consultate la panoramica dell'interfaccia utente Privacy Service. Per un elenco completo di tutti gli endpoint disponibili nell'API Privacy Service, vedete il riferimento API.

Introduzione

Questa guida richiede una buona conoscenza delle seguenti funzionalità di Experience Platform:

• Privacy Service: Fornisce un'API RESTful e un'interfaccia utente che consentono di gestire l'accesso e l'eliminazione delle richieste dagli oggetti dati (clienti) tra le applicazioni Adobe Experience Cloud.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per eseguire 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 richieste formattati correttamente. Viene inoltre fornito un JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consultate la sezione relativa a come leggere chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform.

Raccogli valori per le intestazioni richieste

Per effettuare chiamate all'API Privacy Service, è innanzitutto necessario raccogliere le credenziali di accesso da utilizzare nelle intestazioni richieste:

• Autorizzazione: Portatore {ACCESS_TOKEN}
• x-api-key: {API_KEY}
• x-gw-ims-org-id: {IMS_ORG}

Ciò comporta l'ottenimento delle autorizzazioni per lo sviluppatore per Experience Platform nell'Adobe Admin Console, quindi 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 del Experience Platform. Una volta raggiunto il passaggio "Generate access Credits in Adobe Developer Console", tornate a questa esercitazione per generare le credenziali specifiche per Privacy Service.

Genera credenziali di accesso

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

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

Le {IMS_ORG} e {API_KEY} devono essere generate una sola volta e possono essere riutilizzate nelle chiamate API future. Tuttavia, il {ACCESS_TOKEN} è temporaneo e deve essere rigenerato ogni 24 ore.

Le fasi di generazione di questi valori sono descritte in dettaglio di seguito.

Configurazione una tantum

Andate a Adobe Developer Console ed effettuate l'accesso con il vostro Adobe ID . Seguite quindi i passaggi descritti nell'esercitazione su creazione di un progetto vuoto nella documentazione Developer Console.

Dopo aver creato un nuovo progetto, selezionate Add API nella schermata Project Overview.

Viene visualizzata la schermata Add an API. Selezionare Privacy Service API dall'elenco delle API disponibili prima di selezionare Next.

Viene visualizzata la schermata Configure API. Selezionare l'opzione su Generate a key pair, quindi selezionare Generate keypair nell'angolo inferiore destro.

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 secondo momento). Selezionare Save configured API per completare la configurazione.

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

• CLIENT ID: L'ID client è il valore richiesto {API_KEY} per il quale deve essere specificato nell'intestazione x-api-key.
• ORGANIZATION ID: 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 {ACCESS_TOKEN} utilizzata nell'intestazione Autorizzazione. A differenza dei valori per {API_KEY} e {IMS_ORG}, è necessario generare un nuovo token ogni 24 ore per continuare a utilizzare le API Platform.

Per generare una nuova {ACCESS_TOKEN}, aprite la chiave privata precedentemente scaricata e incollatene il contenuto nella casella di testo accanto a Generate access token prima di selezionare Generate Token.

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

Passaggi successivi

Ora che hai compreso quali intestazioni utilizzare, sei pronto a iniziare a effettuare chiamate all'API Privacy Service. Il documento sui processi di privacy illustra le diverse chiamate API che potete 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.