Casi di utilizzo API comuni

Casi di utilizzo API

Questa pagina evidenzia i modi in cui altri clienti Qualtrics stanno sfruttando l’API Qualtrics. Di seguito troverai un elenco di richieste API comuni utilizzate dai nostri clienti e i casi di utilizzo associati a ciascuna richiesta.

Metodi comuni

Servizio web

La creazione automatica delle richieste API viene generalmente eseguita da uno specialista IT della propria organizzazione, poiché questo processo richiede l’implementazione del codice personalizzato. In alcuni casi, tuttavia, puoi utilizzare un sondaggio Qualtrics per automatizzare invece del codice personalizzato. Le fasi seguenti illustrano come completare questo processo.

Seguire i passaggi seguenti una volta costruito il sondaggio:

1. Vai alla scheda “Sondaggio” e apri il tuo Flusso del sondaggio.
   
2. Fai clic su Aggiungi sotto o Aggiungi qui un nuovo elemento.
3. Selezionare Servizio Web.
4. Inserire l’URL per la richiesta API dalla sezione Definizione della documentazione.
   
5. Selezionare il metodo da utilizzare (ad esempio GET, PUT, POST o DELETE).
   Attenzione: sebbene PATCH sia disponibile nell’elemento Servizio Web, non può essere utilizzato con l’API Qualtrics.
6. Fare clic su Aggiungi un’intestazione personalizzata da inviare al servizio Web.
7. Inserire X-API-TOKEN nel campo Testata per servizio Web e il proprio token nel campo Valore.
   
8. Aggiungere tutti i parametri dell’intestazione richiesti per la richiesta API facendo clic sul segno più (+).
9. Se il Metodo è stato impostato su POST o PUT, fare clic su Aggiungi un parametro del corpo da inviare al servizio Web e immettere tutti i parametri e i valori richiesti.
10. Impostare il valore di ogni parametro sulla sua destra.
    Qtip: desideri utilizzare il Testo Trasferito per i valori con dati dinamici, quali Nome, Cognome e E-mail.

    

11. Se si utilizza API v2.x nell’elemento Servizio Web, è necessario fare clic su Aggiungi un parametro di query da inviare al servizio Web per aggiungere i parametri e i valori URL per le richieste.

JSON

È possibile trasferire i parametri in formato JSON attraverso il corpo della richiesta. Tenere presente che quando si utilizza questo metodo, è necessario specificare un Content-Type (ad es. application/json o text/json). Questo metodo viene generalmente eseguito da uno specialista IT della propria organizzazione, poiché questo processo richiede l’implementazione del codice personalizzato.

Stringa query

URL radice:

https://geomety.qualtrics.com/WRAPI/ControlPanel/api.phpPer

il primo parametro che viene aggiunto all’URL radice, includere un “?” seguito dal nome del parametro, da un segno uguale e dal valore del parametro (ad es. ?)Versione=2.4). Aggiungere tutti i parametri successivi con una E commerciale iniziale “&” (ad esempio, &Request=importPanel).

URL radice + Parametri richiesti:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Versione=2.4&Request=importPanel
 &User=kathleenb_gen&Token=12345678901234567890&Format=XML

Continuare ad aggiungere o aggiungere altri parametri supplementari al proprio URL seguendo lo stesso processo descritto sopra. Una volta inclusi tutti i parametri desiderati, sarà disponibile una richiesta completata.

URL radice + Parametri richiesti + Parametri supplementari:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?Versione=2.4&Request=importPanel
 &User=kathleenb_gen&Token=12345678901234567890&Format=XML
&LibraryID=UR_123456781234567890&ColumnHeaders &1&Email=3&URL=https %D2D23A co2A 2A 2Name

Per ulteriori informazioni sulle stringhe di query, consultare la pagina di supporto Passaggio di informazioni tramite stringhe di query.

Piattaforma sondaggio

Automazione dell’importazione di un elenco di contatti

Puoi utilizzare la richiesta di importazione Crea contatti per importare batch di contatti nel tuo account Qualtrics. Attraverso questa richiesta puoi importare elenchi JSON di persone dal tuo CRM in Qualtrics. Questi contatti possono essere importati caricando un file JSON e impostando il parametro dell’intestazione Content-Type su multipart/form-data o includendo i contatti nel corpo della richiesta e impostando Content-Type su application/json.

Automatizzazione della creazione di un contatto

Invece di aggiornare manualmente gli elenchi dei contatti con i nuovi membri dei contatti, è possibile automatizzare il processo utilizzando la richiesta Crea contatto. Questa richiesta aggiunge un nuovo contatto a un elenco di contatti esistente. Per questa richiesta avrai bisogno dell’ID della lista di invio e di qualsiasi altro campo che desideri aggiungere al contatto. Questi dovranno essere passati attraverso il corpo della richiesta, impostando Content-Type su application/json.

Generazione di collegamenti individuali personali

Potrebbe essere necessario distribuire il sondaggio tramite un mailer interno anziché il mailer Qualtrics. Con l’API Qualtrics, puoi costruire collegamenti individuali che tengono traccia delle informazioni personali di un partecipante senza dover utilizzare il mailer di Qualtrics.

Per completare questa attività, è necessario utilizzare due richieste API: Crea collegamenti di distribuzione e distribuzione. Prima di iniziare, dovrai importare un elenco di contatti in Qualtrics manualmente o utilizzando la richiesta API Crea importazione contatti.

I parametri di interesse per la richiesta di creazione di link di distribuzione e distribuzione sono:

• ID lista di invio (ogni distribuzione è collegata a una lista di invio)
• ID sondaggio
• Descrizione (il nome della distribuzione)
• Azione (il valore qui deve essere CreateDistribution)

Automatizzazione del download dei dati in preparazione all’importazione nel CRM

Se ti trovi a necessitare quotidianamente di dati da molti sondaggi, puoi utilizzare la nostra API per ottenere risposte. L’API v3 utilizza una serie di tre richieste per ottenere dati:

• Crea esportazione risposte: questa richiesta avvia il processo di esportazione e viene utilizzata per specificare il formato del file e altre preferenze. In questo modo verrà restituito un ID esportazione risposta.
• Ottieni avanzamento esportazione risposte: questa richiesta viene utilizzata per controllare l’avanzamento dell’esportazione utilizzando l’ID esportazione risposta fornito nella prima richiesta. Una volta che la percentuale Completa raggiunge 100, è possibile utilizzare l’ultima richiesta per ottenere il file.
• Chiama file di esportazione risposte: una volta che il file è pronto, è possibile utilizzare questa richiesta per scaricarlo. Verrà esportato come file compresso. Notare che sebbene la maggior parte delle richieste API funzionerà quando l’ID del centro dati non è corretto nell’URL, questa richiesta non funzionerà. Assicurarsi di utilizzare l’ID del centro dati corretto in questa richiesta.

Questa sequenza di richieste scarica i tuoi dati grezzi, rendendoti più facile ottenere i tuoi dati e quindi importare quelle risposte nel tuo CRM, data warehouse, ecc.

Directory XM

Aggiornamento di un contatto (Contatti directory lista e Aggiorna contatto directory)

A volte potresti voler aggiornare un contatto tramite l’API. A tal fine, sarà necessario l’ID contatto del contatto. La richiesta API Contatti della directory della lista consente di cercare l’ID contatto di un contatto, che è possibile utilizzare per richieste API successive. Spiegheremo prima la richiesta API Contatti directory lista e poi Aggiorna contatto directory.

Tutto ciò di cui avrai bisogno per la richiesta di contatti della directory della lista è l’ID della directory. Il risultato per la richiesta Contatti directory lista sarà quello di ricevere l’ID Contatto del contatto in modo da poterlo poi utilizzare per richieste quali Aggiorna contatto directory.

Esistono due parametri principali di interesse per la richiesta di aggiornamento del contatto directory: ID directory e ID contatto. Come risultato della richiesta di aggiornamento contatto directory, il contatto specificato verrà aggiornato con le informazioni modificate in base ai parametri della richiesta.

Guide alle soluzioni API

Sul sito Web della documentazione dell’API v3 sono disponibili varie guide alle soluzioni per la gestione dei sondaggi, la gestione di utenti, la gestione di gruppi di utenti e l’ottenimento di risposte ai sondaggi.