Guida introduttiva all’ API Policy Service

L’ API Policy Service ti consente di creare e gestire varie risorse correlate a Adobe Experience Platform Data Governance. Questo documento fornisce un’introduzione ai concetti di base che è necessario conoscere prima di tentare di effettuare chiamate all’ API Policy Service .

Prerequisiti

L’utilizzo della guida per gli sviluppatori richiede una buona comprensione dei vari servizi Experience Platform coinvolti nell’utilizzo delle funzionalità di governance dei dati. Prima di iniziare a lavorare con Policy Service API, controlla la documentazione relativa ai seguenti servizi:

  • Data Governance: Il framework in base al quale Experience Platform viene applicata la conformità per l’utilizzo dei dati.
  • Experience Data Model (XDM) System: Il framework standardizzato in base al quale Experience Platform vengono organizzati i dati sulla customer experience.
  • Real-time Customer Profile: Fornisce un profilo di consumatore unificato e in tempo reale basato su dati aggregati provenienti da più origini.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola Platform istanza in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

Lettura di chiamate API di esempio

La documentazione Policy Service API 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 .

Intestazioni richieste

La documentazione API richiede inoltre di aver completato l’ esercitazione sull’autenticazione per effettuare correttamente le chiamate agli endpoint Platform. Il completamento dell’esercitazione di autenticazione fornisce i valori per ciascuna delle intestazioni richieste nelle chiamate API Experience Platform, come mostrato di seguito:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Tutte le risorse in Experience Platform, comprese quelle appartenenti a Data Governance, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle API Platform richiedono un’intestazione che specifichi il nome della sandbox in cui avrà luogo l’operazione:

  • x-sandbox-name: {SANDBOX_NAME}
NOTA

Per ulteriori informazioni sulle sandbox in Platform, consulta la documentazione di panoramica sandbox.

Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un’intestazione aggiuntiva:

  • Content-Type: application/json

Core e risorse personalizzate

All’interno dell’API Policy Service, tutti i criteri e le azioni di marketing sono definiti risorse core o custom.

core le risorse sono quelle definite e gestite dall’Adobe, mentre custom le risorse sono quelle create e gestite dall’organizzazione e sono quindi uniche e visibili solo all’organizzazione IMS. Le operazioni di elenco e ricerca (GET) sono pertanto le uniche operazioni consentite sulle risorse core, mentre le operazioni di elenco, ricerca e aggiornamento (POST, PUT, PATCH e DELETE) sono disponibili per le risorse custom.

Passaggi successivi

Per iniziare a effettuare chiamate utilizzando l'API di Policy Service, seleziona una delle guide degli endpoint disponibili.

In questa pagina