Come si formatta una richiesta API?
I formati di richiesta variano a seconda dell'API Experience Platform utilizzata. Il modo migliore per scoprire come strutturare le chiamate API è seguire gli esempi forniti nella documentazione del servizio Experience Platform specifico che si sta utilizzando.
Per ulteriori informazioni sulla formattazione delle richieste API, consulta la guida introduttiva all'API Experience Platform lettura di chiamate API di esempio.
Qual è la mia organizzazione?
Un’organizzazione è una rappresentazione Adobe di un cliente. Tutte le soluzioni Adobe con licenza sono integrate in questa organizzazione del cliente. Quando un'organizzazione ha diritto a Experience Platform, può assegnare l'accesso agli sviluppatori. L'ID organizzazione (x-gw-ims-org-id
) rappresenta l'organizzazione per la quale deve essere eseguita una chiamata API ed è pertanto richiesto come intestazione in tutte le richieste API. Questo ID si trova tramite Adobe Developer Console: nella scheda Integrazioni, accedi alla sezione Panoramica per trovare una particolare integrazione per l'ID in Credenziali client. Per informazioni dettagliate su come eseguire l'autenticazione in Experience Platform, vedere esercitazione sull'autenticazione.
Dove posso trovare la mia chiave API?
È necessaria una chiave API come intestazione in tutte le richieste API. È disponibile tramite Adobe Developer Console. Nella console, nella scheda Integrazioni, passa alla sezione Panoramica per un'integrazione specifica e troverai la chiave in Credenziali client. Per informazioni dettagliate su come eseguire l'autenticazione in Experience Platform, vedere esercitazione sull'autenticazione.
Come si ottiene un token di accesso?
I token di accesso sono necessari nell’intestazione Autorizzazione di tutte le chiamate API. Possono essere generati utilizzando un comando CURL, a condizione che tu abbia accesso a un’integrazione per un’organizzazione. I token di accesso sono validi solo per 24 ore, dopo di che è necessario generare un nuovo token per continuare a utilizzare l’API. Per informazioni dettagliate sulla generazione dei token di accesso, consulta l'esercitazione sull'autenticazione.
Come si utilizzano i parametri di query?
Alcuni endpoint API Experience Platform accettano parametri di query per individuare informazioni specifiche e filtrare i risultati restituiti nella risposta. I parametri di query vengono aggiunti ai percorsi di richiesta con il simbolo del punto interrogativo (?
) seguito da uno o più parametri di query nel formato paramName=paramValue
. Quando si combinano più parametri in una singola chiamata, è necessario utilizzare una e commerciale (&
) per separare i singoli parametri. L’esempio seguente illustra come viene rappresentata nella documentazione una richiesta che utilizza più parametri di query.
Esempi di parametri di query comunemente utilizzati includono:
GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created
Per informazioni dettagliate sui parametri di query disponibili per un servizio o un endpoint specifico, consulta la documentazione relativa al servizio.
Come si indica un campo JSON da aggiornare in una richiesta PATCH?
Molte operazioni PATCH nelle API Experience Platform utilizzano stringhe JSON Pointer per indicare le proprietà JSON da aggiornare. Questi sono in genere inclusi nei payload di richiesta utilizzando il formato Patch JSON. Per informazioni dettagliate sulla sintassi richiesta per queste tecnologie, consulta la guida sui concetti fondamentali dell'API.
Posso usare Postman per effettuare chiamate alle API Experience Platform?
Postman è uno strumento utile per visualizzare le chiamate alle API RESTful. La guida introduttiva all'API di Experience Platform contiene un video e le istruzioni per l'importazione delle raccolte Postman. Inoltre, viene fornito un elenco di raccolte Postman per ciascun servizio.
Requisiti di sistema per Experience Platform
A seconda che si utilizzi l’interfaccia o l’API, si applicano i seguenti requisiti di sistema:
Per operazioni basate sull'interfaccia utente:
- Un browser web moderno e standard. Sebbene sia consigliata l'ultima versione di Chrome, sono supportate anche le versioni principali corrente e precedenti di Firefox, Internet Explorer e Safari.
- Ogni volta che viene rilasciata una nuova versione principale, Experience Platform inizia a supportare la versione più recente, mentre il supporto per la terza versione più recente viene rimosso.
- Tutti i browser devono avere cookie e JavaScript abilitati.
Per interazioni con API e sviluppatori:
- Un ambiente di sviluppo da sviluppare per le integrazioni REST, streaming e Webhook.