Lettura delle chiamate API di esempio

La documentazione API Real-Time Customer Profile fornisce esempi di chiamate API per dimostrare come formattare correttamente 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 Experience 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 sono isolate in specifiche sandbox virtuali. Le richieste alle API Experience Platform richiedono un'intestazione che specifichi il nome della sandbox in cui verrà eseguita l'operazione:

  • x-sandbox-name: {SANDBOX_NAME}

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

Tutte le richieste con un payload nel corpo della richiesta (come chiamate POST, PUT e PATCH) devono includere un'intestazione Content-Type. I valori accettati specifici di ogni chiamata sono forniti nei parametri della chiamata.