Iniziare con l’API Qualtrics
Informazioni sull’API Qualtrics
L’API Qualtrics può essere utilizzata per automatizzare i processi ripetitivi all’interno di Qualtrics o per trasmettere informazioni in entrata e in uscita da Qualtrics. Ad esempio, un Amministratore della licenza può utilizzare l’API Qualtrics per automatizzare il processo di creazione dell’account piuttosto che creare centinaia di account singolarmente. Analogamente, un utente può automatizzare la creazione dell’elenco dei contatti piuttosto che compilare e importare manualmente gli elenchi di contatti. Qualtrics dispone anche di varie guide alle soluzioni API che possono aiutarti a determinare il modo migliore per utilizzare l’API in base alle tue esigenze.
Accesso API per diversi prodotti
Qualtrics dispone di una varietà di prodotti diversi che ti consentono di raccogliere dati utilizzabili in tempo reale. Alcuni di questi prodotti includono la Survey Platform, Site Intercept e la XM Directory (Target Audience). Una volta acquistata la funzione API di Qualtrics, sarai in grado di utilizzarla per tutti i prodotti che fanno parte della tua licenza.
Di seguito sono riportati i collegamenti alla documentazione per la versione più recente dell’API per ogni prodotto:
- Per le API più recenti per la maggior parte dei prodotti, consulta API Qualtrics
- Intercetta del sito
Si consiglia sempre ai clienti di utilizzare la versione più recente dell’API.
Comprensione dell’API v3 di Qualtrics
L’API v3 di Qualtrics è una REST API che ti consente di comunicare o interrogare il nostro sistema utilizzando una semplice sintassi URL. La comunicazione con il sistema Qualtrics può essere pensata come una sequenza di richieste. Puoi richiedere informazioni da inviare a Qualtrics, aggiornarle, rimuoverle o restituirle al tuo sistema. Queste richieste possono essere effettuate da richieste GET, POST, PUT o DELETE che restituiscono risposte JSON.
Attraverso questi mezzi, l’API Qualtrics ti consente di interagire con parti del sistema Qualtrics e integrare queste aree con il tuo CRM.
Iniziare ora
Parametri di trasmissione
I parametri sono i moduli per le richieste dell’utente. Ogni richiesta API richiede la trasmissione di diversi parametri globali a Qualtrics, oltre a più parametri specifici della richiesta e alcuni facoltativi.
Sarà sempre necessario trasferire il token API attraverso l’intestazione della richiesta come X-API-TOKEN. A seconda della specifica richiesta in esecuzione, potrebbe essere necessario passare altri parametri attraverso l’intestazione, l’URL o il corpo della richiesta. Quando si trasferiscono i parametri nel corpo, è necessario inviarli come JSON. Quando si utilizza questo metodo, è necessario specificare un Content-Type (ad es. application/json o multipart/form-data).
Esempio: nel seguente esempio POST, in cURL si specifica l’URL base, il Content-Type e il Token nell’intestazione. L’ID indagine e il formato dell’esportazione sono specificati in
body.curl -X POST -H 'X-API-TOKEN: yourapitokenhere' -H 'Content-Type: application/json' -d '{
"SurveyId": "SV_012345678912345",
"format": "csv"
}' 'https://yourdatacenterid.qualtrics.com/API/v3/responseexports'
Generazione di un token API
Sarà richiesto un token API per accedere all’API Qualtrics. Ogni utente in una licenza deve generare il proprio token API. Il token API del proprio account è richiesto per autenticare ogni richiesta API creata. Il token viene utilizzato al posto della password dell’account e contribuisce a migliorare la sicurezza del lavoro. Per eseguire l’autenticazione, includere il token nell’intestazione HTTPS X-API-TOKEN.
Generazione di un token API
- Fare clic sull’icona delle impostazioni utente nell’angolo in alto a destra dell’account.
- Seleziona Impostazioni account.
- Fai clic su ID Qualtrics sulla barra di navigazione.
- Nella casella API con etichetta, fare clic su Genera token.
Creazione di una chiave client segreta
- Fai clic sull’icona delle impostazioni utente nell’angolo in alto a destra del tuo account Qualtrics.
- Seleziona Impostazioni account.
- Vai agli ID Qualtrics.
- Selezionare Gestione client OAuth.
- Fare clic su Crea client.
- Inserisci un nome client.
- Se lo si desidera, inserire un indirizzo di posta elettronica del contatto.
- Per Concedi tipo, selezionare Credenziali client.
- Fare clic su Crea client.
- Annotare l’ID client e la chiave client segreta e archiviarli in un’ubicazione sicura.
Attenzione: una volta usciti da questa finestra, la Chiave segreta client è irrecuperabile. Se si perde o si dimentica la chiave client segreta, sarà necessario ripetere il processo precedente per generarne uno nuovo.