Customer Experience
Employee Experience
Brand Experience
Core XM
Design XM

Utilizzo della documentazione delle API Qualtrics

Informazioni sulla documentazione API

La nostra pagina Documentazione API Qualtrics fornisce dettagli su tutta la documentazione attualmente disponibile.

Questa pagina ti guiderà su come navigare nella nostra documentazione, delineando cosa discute ogni sezione e cosa è disponibile.

Panoramica

Nella Panoramica API, puoi visualizzare informazioni sull’API di Qualtrics in generale, nonché informazioni sulla paginazione (ad esempio, se esegui una richiesta Contatti elenco e hai più di 100 contatti, il risultato verrà impaginato e verrà fornito un URL della pagina successiva per ottenere i successivi 100 – questo si applica a tutte le richieste di raccolta).

Server Qualtrics lista di elementi consentiti

Vedere Allowlist Qualtrics Server.

URL di base e ID centro dati

Questa sottosezione mostra come trovare l’ID del centro dati che sarà necessario includere nell’URL di base per le richieste API.

Ricerca degli ID Qualtrics

Questa sottosezione mostra i punti in cui è possibile trovare i vari ID necessari durante l’esecuzione delle richieste API. Per gli ID non disponibili in questa sezione, consulta Individuazione degli ID Qualtrics mediante il controllo dell’elemento.

Autenticazione

La sottosezione Autenticazione illustra le informazioni necessarie per autenticare le richieste, nonché i suggerimenti per proteggere il token API. Per ulteriori informazioni sul processo di autenticazione, visualizzare Generazione di un token API.

Parametri

La sottosezione Parametri copre i diversi metodi di trasmissione dei parametri in base al 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 per ogni codice di risposta. La nostra API restituisce sempre risposte in JSON, tranne nel caso della richiesta di esportazione della risposta in cui il file può essere restituito in qualsiasi formato disponibile.

Consiglio Q: se non vedi Risposte o Aggiorna da versioni precedenti come opzioni nella documentazione, assicurati di selezionare Visualizza tutto 7 in fondo all’elenco della sezione API.

Utilizzo delle API Qualtrics

Questa sezione della documentazione include frammenti di codice in Python e Java per aiutarti a sviluppare flussi di lavoro per la gestione di sondaggi e utenti e per ottenere i risultati del sondaggio.

Avvertenza: le funzionalità di codifica personalizzata sono fornite così com’è e potrebbero richiedere conoscenze di programmazione per l’implementazione. Il nostro team di supporto non offre assistenza o consulenza sulla codifica personalizzata. Puoi invece provare a domandare alla nostra community di utenti esperti. Se desideri maggiori informazioni sui nostri servizi di programmazione personalizzata, contatta il tuo Account Executive Qualtrics.

Riferimento

La sezione Riferimento contiene informazioni importanti su formati di data e ora accettabili, codici lingua, limiti di richieste e dettagli sugli abbonamenti agli eventi. Le sottoscrizioni agli eventi consentono di inviare notifiche a un URL di pubblicazione una volta che si verifica un evento (ad esempio, una risposta in fase di registrazione).

Richieste

Per aiutare a organizzare la documentazione e aiutare gli utenti a trovare le richieste API che stanno cercando, le richieste vengono categorizzate come segue:

Organizzazioni
Divisioni
Gruppi
Utenti
Sondaggi
Esportazione delle risposte del sondaggio
Risposte
Importazioni risposte
Libreria di messaggi
Libreria di grafica
Distribuzioni
Contatti della piattaforma Insights
Iscrizioni all’evento
Directory XM (Target Audience)

Richiedi parametri e opzioni

Ogni richiesta API ha un nome, una breve descrizione, una tabella che elenca i possibili parametri, la risposta, una richiesta di esempio in cURL e la procedura guidata “Try It Out”. Comprendere come utilizzare queste informazioni può aiutare a snellire il lavoro.

Nome, descrizione e URL

Le prime 3 cose che sono elencate per qualsiasi richiesta API sono il verbo HTTP, il nome della richiesta API e una breve descrizione della richiesta.

L’URL utilizzato nella richiesta (o “definizione”) verrà elencato accanto al verbo HTTP.

Prendere nota della struttura dettagliata utilizzata negli URL. Ad esempio:

La richiesta Elenca liste di invio utilizza il seguente URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists
Puoi quindi utilizzare un ID restituito con quella richiesta per ottenere una specifica lista di invio aggiungendo l’ID alla fine dell’URL: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId
Per elencare i contatti all’interno di quella lista di invio, aggiungi contatti alla fine: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts
Per ottenere un contatto specifico, è quindi possibile utilizzare un contactId restituito nella richiesta precedente: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts/:contactId

Elenco di parametri del corpo

Per ogni richiesta API, verrà visualizzata una tabella che elenca tutti i possibili parametri del corpo che possono essere utilizzati (alcuni facoltativi, altri obbligatori). Questa tabella contiene le seguenti informazioni:

Nome di ogni parametro
I formati accettati per ogni parametro
Se il parametro è obbligatorio
Una breve descrizione del parametro

Attenzione: tutti i nomi e i valori dei parametri fanno distinzione tra maiuscole e minuscole.

Campione richiesta

Il campione di richiesta fornito nella documentazione mostra come formattare la richiesta in cURL. Queste richieste includono l’URL radice e tutti i parametri richiesti dalla tabella dei parametri.

Qtip: poiché gli ID sono solo esempi e non ID reali, le richieste contenute negli esempi non funzioneranno effettivamente, ma è sufficiente sostituirli con ID del proprio account.

Esempio di risposta

Questa sezione fornisce un esempio di ciò che puoi aspettarti di ricevere una volta che la richiesta API avrà esito positivo. Ad esempio, se si utilizza la richiesta API Crea utente, la risposta sarà l’ID utente dell’utente appena creato.

Completamento delle richieste API nel sito API

La nostra documentazione API consente di eseguire rapidamente e facilmente una richiesta API. (Tieni presente che la maggior parte delle richieste API richiedono ID Qualtrics.)

Attenzione: usare cautela durante il test delle API. Se si inseriscono le informazioni minime richieste per eseguire una chiamata API, questo modale completerà la richiesta API. I campi obbligatori variano a seconda della chiamata API e verranno elencati nella pagina della chiamata.

Selezionare tra Chiave API e OAuth 2.0.
Immettere il token API del proprio account nel campo Token API. (o le informazioni OAuth 2.0 corrispondenti, se si è selezionato OAuth 2.0).
Inserire eventuali parametri supplementari.
Fare clic su Utenti per scegliere un server su cui eseguire il test. Per la verifica più accurata, si desidera che corrisponda al centro dati del proprio account.
Premere Invia richiesta API per testare la chiamata API.

Qtip: per sapere quali valori sono accettabili per ogni parametro, fare riferimento alla tabella dei parametri per la richiesta. È anche possibile fare riferimento all’esempio cURL nella documentazione.

Una volta inseriti i valori necessari per la richiesta, l’output della chiamata verrà visualizzato alla voce “Risposta”.

Attenzione: alcune richieste non funzionano con questa funzione di test. Questo verrà indicato nella maschera per la richiesta.

Molte delle pagine di questo sito sono state tradotte dall'originale in inglese mediante traduzione automatica. Sebbene in Qualtrics abbiamo profuso il massimo impegno per avere le migliori traduzioni automatiche possibili, queste non sono mai perfette. Il testo originale inglese è considerato la versione ufficiale, e qualsiasi discrepanza tra questo e le traduzioni automatiche non è legalmente vincolante.