Guida introduttiva all'API Policy Service
L'API Policy Service consente di creare e gestire varie risorse relative alla governance dei dati di Adobe Experience Platform. 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 conoscenza dei vari servizi Experience Platform coinvolti nell'utilizzo delle funzionalità di governance dei dati. Prima di iniziare a utilizzare Policy Service API, consulta la documentazione dei seguenti servizi:
- Governance dei dati: framework tramite il quale Experience Platform impone la conformità all'utilizzo dei dati.
- Experience Data Model (XDM) System: framework standardizzato tramite il quale Experience Platform organizza i dati sull'esperienza del cliente.
- Real-Time Customer Profile: fornisce un profilo consumer unificato e in tempo reale basato su dati aggregati provenienti da più origini.
- Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Platform in ambienti virtuali separati, utili per le attività di sviluppo e aggiornamento delle applicazioni di esperienza digitale.
Lettura delle chiamate API di esempio
La documentazione API Policy Service 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 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 del tutorial di autenticazione fornisce i valori per ciascuna delle intestazioni richieste nelle chiamate API Experience Platform, come illustrato di seguito:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}
Tutte le risorse in Experience Platform, incluse quelle appartenenti a Governance dei dati, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle API Platform richiedono un'intestazione che specifichi il nome della sandbox in cui verrà eseguita l'operazione:
x-sandbox-name: {SANDBOX_NAME}
Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un’intestazione aggiuntiva:
Content-Type: application/json
Risorse core e personalizzate
Nell'API Policy Service, tutti i criteri e le azioni di marketing sono denominati core
o custom
risorse.
Le risorse core
sono quelle definite e gestite da Adobe, mentre le risorse custom
sono quelle create e gestite dalla tua organizzazione e sono quindi univoche e visibili solo alla tua organizzazione. Le operazioni di elenco e ricerca (GET
) sono pertanto le uniche operazioni consentite nelle 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 del servizio criteri, seleziona una delle guide degli endpoint disponibili.