Autenticazione e accesso all’API di Privacy Service

Ultimo aggiornamento: 2024-02-29
  • Argomenti:
  • Privacy
    Visualizza ulteriori informazioni su questo argomento
  • Creato per:
  • Developer

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 come consente di gestire le richieste di accesso ed eliminazione da parte degli interessati (clienti) in tutte le 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 di quali autorizzazioni dispone l’integrazione quando si accede alle funzionalità di Privacy Service. Consulta la guida su gestione delle autorizzazioni di Privacy Service per ulteriori informazioni.

Raccogliere i valori per le intestazioni richieste

Per effettuare chiamate all’API Privacy Service, devi innanzitutto 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. Il tuo {ORG_ID} e {API_KEY} deve essere generato una sola volta e può essere riutilizzato 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.

L’opzione API selezionata da Aggiungi al progetto dalla pagina dei dettagli del progetto in Console sviluppatori

Seleziona l’API Privacy Service

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

La scheda API Privacy Service selezionata dall’elenco delle API disponibili

SUGGERIMENTO

Seleziona la Visualizza documenti per passare in una finestra del browser separata al Documentazione di riferimento dell’API Privacy Service.

Quindi, seleziona il tipo di autenticazione per generare token di accesso e accedere all’API Privacy Service.

IMPORTANTE

Seleziona la OAuth Server-to-Server poiché questo sarà l’unico metodo supportato per andare avanti. Il Account di servizio (JWT) è obsoleto. Anche se le integrazioni che utilizzano il metodo di autenticazione JWT continueranno a funzionare fino al 1° gennaio 2025, Adobe consiglia vivamente di migrare le integrazioni esistenti al nuovo metodo server-to-server OAuth prima di tale data. Ulteriori informazioni nella sezione ObsoletoGenerare un token web JSON (JWT).

Selezionare il metodo di autenticazione tra server OAuth.

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.

NOTA

I profili di prodotto e le autorizzazioni granulari che forniscono vengono creati e gestiti dagli amministratori tramite Adobe Admin Console. Consulta la guida su Autorizzazioni 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 API PRIVACY SERVICE nella pagina del progetto vengono visualizzate le seguenti credenziali necessarie in tutte le chiamate alle API Privacy Service:

  • {API_KEY} (ID client)
  • {ORG_ID} (ID organizzazione)

Informazioni sull’integrazione dopo l’aggiunta di un’API in Console sviluppatori.

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 un nuovo {ACCESS_TOKEN}, passa a Credenziali > OAuth Server-to-Server e seleziona Genera token di accesso, come illustrato di seguito.

Registrazione schermata della modalità di generazione di un token di accesso nell’interfaccia utente di Console sviluppatori.

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, consulta la sezione su utilizzo di Postman per autenticare e testare le chiamate API nella guida di autenticazione API di Experienci 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 esempi di chiamate API nella guida introduttiva per le API di 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:

In questa pagina