Utilizzo della documentazione API di Qualtrics
Cosa puoi trovare in questa pagina
Informazioni sulla documentazione API
La nostra pagina Documentazione API di QUALTRICS riporta in dettaglio tutta la documentazione attualmente disponibile.
Questa pagina spiega come navigare nella nostra documentazione, indicando cosa tratta ogni sezione e cosa è disponibile.
Panoramica
Nella Panoramica API, è possibile visualizzare informazioni sull’API di Qualtrics in generale, nonché informazioni sulla paginazione (ad esempio, se si esegue una richiesta di Elenco CONTATTI e si hanno più di 100 contatti, il risultato verrà paginato e verrà fornito un URL AVANTI per ottenere i 100 contatti successivi; ciò si applica a tutte le richieste di raccolta).
Consentire i server di Qualtrics
Vedere Allowlist Server di Qualtrics.
URL di base e ID del centro dati
Questa sottosezione mostra come trovare l’ID del datacenter da includere nell’URL di base per le richieste API.
Trovare gli ID di Qualtrics
Questa sottosezione mostra dove trovare i vari Api necessari per l’esecuzione delle richieste API. Per gli ID che non sono disponibili in questa sezione, consultare la sezione Individuare gli ID di Qualtrics ispezionando l’elemento.
Autenticazione
La sottosezione Autenticità illustra le informazioni necessarie per l’autenticazione delle richieste e i suggerimenti per proteggere il token API. Per ulteriori informazioni sul processo di autenticazione, vedere Generazione di un token API.
Parametri
La sottosezione Parametri tratta i diversi metodi di passaggio dei parametri, a seconda del metodo HTTP utilizzato (GET, POST, PUT o DELETE).
Risposte
La sottosezione Risposte contiene esempi dei diversi codici di risposta HTTP che possono essere restituiti quando si esegue una richiesta, nonché i possibili motivi di ciascun codice di risposta. Le nostre API restituiscono sempre risposte in JSON, tranne nel caso della richiesta di esportazione delle risposte, dove il file può essere restituito in uno qualsiasi dei formati disponibili.
Consiglio Q: se nella documentazione non sono presenti le opzioni Risposte o Aggiornamento da versioni precedenti, assicurarsi di selezionare Visualizza tutti i 7in fondo alla lista della sezione API.
Utilizzo delle API di Qualtrics
Questa sezione della documentazione contiene frammenti di codice in Python e Java che aiutano a sviluppare flussi di lavoro per la gestione dei sondaggi e degli utenti e per ottenere i risultati dei sondaggi.
Attenzione: Le funzioni di codifica personalizzate sono fornite così come sono e possono richiedere conoscenze di programmazione per essere implementate. Il nostro team di supporto non offre assistenza o consulenza per la codifica personalizzata. Puoi sempre provare a chiedere alla nostra community di utenti esperti. Se desiderate saperne di più sui nostri servizi di codifica personalizzata, contattate il vostro Account Executive di Qualtrics.
Riferimento
La sezione Riferimento contiene informazioni importanti sui formati di data e ora accettabili, sui codici lingua, sui limiti delle richieste e sui dettagli relativi alle sottoscrizioni di eventi. Le RISPOSTA REGISTRATA consentono di inviare notifiche a un URL di pubblicazione quando si verifica un evento (ad esempio, la registrazione di una risposta).
Richieste
Per organizzare la documentazione e aiutare gli utenti a trovare le richieste API che stanno cercando, le richieste sono classificate come segue:
- Organizzazioni
- Divisioni
- Gruppi
- Utenti
- Sondaggi
- Esportazione delle risposte al sondaggio
- Risposte
- Importazioni risposte
- Libreria di messaggi
- Libreria di grafica
- Distribuzioni
- Contatti della piattaforma Insights
- Iscrizioni all’evento
- Directory XM (Target Audience)
Parametri e opzioni della richiesta
Ogni richiesta API ha un nome, una breve descrizione, una lista di possibili parametri, la risposta, un esempio di richiesta in cURL e la procedura guidata “Try It Out”. Capire come utilizzare queste informazioni può aiutare a semplificare il lavoro.
Nome, descrizione e URL
Le prime 3 cose che vengono elencate per ogni richiesta API sono il verbo HTTP, il nome della richiesta API e una breve descrizione della richiesta.
L’URL utilizzato nella richiesta (o “definizione”) sarà elencato avanti al verbo HTTP.
Si noti la struttura a tendina utilizzata negli URL. Ad esempio:
- La richiesta Lista DI INVIO utilizza il seguente URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists
- È quindi possibile utilizzare un ID restituito con la richiesta per ottenere una lista di invio specifica, aggiungendo l’ID alla fine dell’URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId
- Per elencare i contatti di quella lista di invio, aggiungere i contatti alla fine: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts
- Per ottenere un contatto specifico, è possibile utilizzare un contactId restituito nella richiesta precedente: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts/:contactId
Lista dei parametri dell’organismo
Per ogni richiesta API, si troverà una lista di tutti i possibili parametri del corpo che possono essere usati (alcuni saranno opzionali, altri obbligatori). Questa tabella contiene le seguenti informazioni:
- Il nome di ogni parametro
- I formati accettati per ciascun parametro
- Se il parametro è richiesto
- Breve descrizione del parametro
Attenzione: Tutti i nomi e i valori dei parametri sono sensibili alle maiuscole e alle minuscole.
Campione
Il campione di richiesta fornito nella documentazione mostra come formattare la richiesta in cURL. Queste richieste includono l’URL principale e tutti i parametri richiesti dalla tabella dei parametri.
Consiglio Q: poiché gli ID sono solo esempi e non ID reali, le richieste degli esempi non funzioneranno, ma è sufficiente sostituirle con ID del proprio account.
Esempio di risposta
Questa sezione fornisce un esempio di ciò che ci si può aspettare di ricevere una volta che la richiesta API è andata a buon fine. Ad esempio, se si utilizza la richiesta API Create User, la risposta sarà l’ID utente del nuovo utente creato.
Completamento delle richieste Api sul sito API
La nostra documentazione Api consente di eseguire rapidamente e facilmente una richiesta API. (Si noti che la maggior parte delle richieste API richiede gli ID di QUALTRrics)
Attenzione: Usare cautela quando si testano le API. Se si inseriscono le informazioni minime richieste per eseguire una chiamata API, questa maschera completerà la richiesta API. I campi obbligatori variano a seconda della chiamata API e sono elencati nella pagina della chiamata.
Consiglio Q: Per sapere quali valori sono accettabili per ogni parametro, consultare la tabella dei parametri della richiesta. Si può anche fare riferimento all’esempio di cURL nella documentazione.
Una volta inseriti i valori necessari per la richiesta, si vedrà l’output della chiamata alla voce “Risposte”
Attenzione: Alcune richieste non funzionano con questa funzione di test. Questo sarà indicato nella pagina della richiesta.
È fantastico! Grazie per il tuo feedback!
Grazie per il tuo feedback!