Evento JSON
Cosa puoi trovare in questa pagina
Consiglio Q: gli Eventi JSON sono disponibili solo per gli utenti che hanno acquistato l’accessibilità alle API di Qualtrics. Se siete interessati a questa funzione, rivolgetevi al vostro Account Executive o all’Account Services.
Informazioni sull’evento JSON
Avete mai voluto che una richiesta fatta sul vostro sito web facesse scattare un ticket in Qualtrics? Avete mai desiderato creare un’integrazione perfetta tra Qualtrics e il vostro sistema interno? Vi è mai capitato di voler triggerare un’attività nella scheda Flussi di lavoro, ma con un evento che si verifica al di fuori di Qualtrics?
Gli eventi JSON consentono a software esterni di avviare flussi di lavoro tramite richiesta HTTP. Invece di aspettare che un evento in Qualtrics attivi ulteriori azioni nella piattaforma, è possibile configurare semplicemente un evento JSON per ricevere richieste da terze parti.
Consiglio Q: è necessario generare un token API prima che questa funzione sia disponibile. Se si dispone già di un token API, non è necessario generarne uno nuovo.
Attenzione: L’impostazione di un evento JSON richiede conoscenze avanzate di programmazione. Sebbene il nostro team di assistenza sia lieto di aiutarvi con le basi dell’inserimento delle informazioni nell’evento, non possiamo fornire assistenza sugli aspetti di programmazione. Puoi invece provare a domandare alla nostra community di utenti esperti.
Limitazioni
L’evento JSON non è compatibile con le seguenti impostazioni e configurazioni:
- Tutto ciò che non è HTTP (ad esempio, coda di messaggi, SMS).
- Chiamate HTTP in uscita.
- Elaborare XML (il corpo della richiesta XML sarà ignorato).
- Elaborare qualsiasi cosa che non sia JSON.
- Autenticarsi in qualsiasi altro modo che non sia un’intestazione X-API-TOKEN o il nostro HTTP basic auth modificato. Consiglio Q: OAuth e altre forme di autenticatori sono incompatibili con gli eventi JSON.
- Qualsiasi parsing JSON che non può essere soddisfatto utilizzando le query JSONPath sul corpo JSON.
- Chiamate che superano il limite della tariffa API di 3.000 al minuto.
- Carichi utili superiori a 100 KB.
- 10 campi di immissione manuale. Consiglio Q: una volta che le informazioni sono state acquisite con la cattura degli eventi, saranno aggiunte al corpo JSON. L’acquisizione degli eventi è l’unico modo per aggiungere più di 10 campi.
Tipi di autorizzazione supportati
Autenticazione basata su token / Autenticazione tramite intestazione
È possibile autenticarsi passando il proprio token API nell’intestazione della richiesta come X-API-TOKEN.
Esempio: Nel seguente esempio di POST, in cURL si specificano l’URL di base, il Content-Type e il Token nell’intestazione. L’ID del sondaggio e il formato dell’esportazione sono specificati nel corpo
.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'
Autenticazione di base HTTP
Basic Auth è solitamente una versione codificata Base64 di nome utente:password. Tuttavia, per una maggiore sicurezza, Qualtrics utilizza una stringa codificata Base64 di username:x-api-token.
Per utilizzare Basic Auth, è necessario impostare le intestazioni sulla richiesta HTTP. L’intestazione specifica è AUTORITÀ.
Esempio: Supponiamo che il vostro nome utente di Qualtrics sia demo@qualtrics.com e che il vostro TOKEN API sia f8gIK7G6GFH985Y4. Per prima cosa scrivete,
demo@qualtrics.com:f8gIK7G6GFH985Y4Dopo la codifica Base64, questo apparirà come,
Base ZGVtb0BxdWFsdHJpY3MuY29tOmY4Z0lLN0c2R0ZIOTg1WTQ=Quindi l’intestazione Autorizzazione aggiunta alla richiesta HTTP avrà il valore Basic ZGVtb0BxdWFsdHJpY3MuY29tOmY4Z0lLN0c2R0ZIOT1WTQ=.
Consiglio Q: dare un’occhiata a questi strumenti per la codifica di base64 e la decodifica di base64.
Impostazione di un evento JSON
Consiglio Q: fare clic sull’evento JSON per modificare i parametri e i campi JSON.
Attenzione: Un evento JSON può essere lanciato via API solo dallo stesso account che ha creato l’evento. Se si utilizza un account diverso per lanciare l’API per un evento JSON, è possibile che si riceva una risposta API 202-success, tuttavia ciò significa che è stato utilizzato un token API valido per effettuare una richiesta valida, ma non significa necessariamente che sia stato utilizzato il token API corretto o che l’evento JSON sia stato attivato correttamente. Se si riceve un messaggio API 202-success, è necessario controllare la piattaforma per verificare che sia stata utilizzata l’API corretta.
Cattura degli eventi
Quando si crea un evento API esterno, potrebbe essere necessario analizzare i dati dal corpo del post. Tuttavia, a volte può essere difficile analizzare questi dati. Se si vuole capire cosa sta inviando l’API esterna, seguire questi passaggi.
Sintassi di JSONPath
La tabella seguente fornisce alcune delle basi della sintassi di JSONPath. Si noti che questi non sono stabiliti da Qualtrics, ma sono standard utilizzati con JSON.
Attenzione: L’impostazione di un evento JSON richiede conoscenze avanzate di programmazione. Sebbene il nostro team di assistenza sia lieto di aiutarvi con le basi dell’inserimento delle informazioni nell’evento, non possiamo fornire assistenza sugli aspetti di programmazione. Potete sempre provare a chiedere alla nostra comunità di utenti dedicati.
| Percorso JSON | Descrizione | Esempio |
|---|---|---|
| $ | L’oggetto/elemento principale | $.negozi[0].nome |
| @ | L’oggetto/elemento corrente | $.stores[?(@.name==”ACME Store”)] |
| . | Operatore bambino | $.eventDescription |
| .. | Operatore discendente ricorsivo | $.negozi[0]..prezzo |
| * | Jolly | $.negozi[*].nome |
| [] | Operatore di pedice | $.negozi[0].nome |
| [,] | Operatore dell’Unione | $.negozi[0,1] |
| [inizio:fine:passo] | Operatore di taglio della matrice | $.stores[0:10:2] |
| ?() | APPLICA un filtro | $.stores[?(@.name==”ACME Store”)] |
| () | Espressione di script | $.stores[(@.length-1)] |
Esempio di sintassi JSONPath
In questo esempio mostreremo come, dato un oggetto JSON, si possa utilizzare la tabella JSONPath.
Questo è il nostro oggetto JSON:
{
"eventDescription": "Entrate mensili",
"negozi": [
{
"nome": "Acme Store",
"total": 1000000,
"topItem":
{ "price": "50", "descrizione": "Incudine" }
},
{
"nome": "Il chiosco delle banane",
"totale": 250000,
"topItem":
{ "prezzo": "4", "descrizione": "Il Gob" }
},
{
"name": "Pizza Planet",
"totale": 80000,
"topItem":
{ "prezzo": "15", "descrizione": "Pepperoni" }
}
]
}
Ora dovremmo aggiungere i valori di ritorno che vediamo nella tabella JSONPath per rendere il tutto più chiaro.
$ -> Acme Store
@ -> [
{
"nome": "Acme Store",
"total": 1000000,
"topItem":
{ "price": "50", "descrizione": "Incudine" }
}
]
. -> Entrate mensili
... -50
-> ["Acme Store", "The Banana Stand", "Pizza Planet"]
[] -> Acme Store
[,] -> [
Macro sconosciuta: {"nome"}
,
Macro sconosciuta: {"nome"}
]
**Cambia l'Esempio di [inizio:fine:passo] con "$.negozi[1:3:1]"
[start:end:step] -> [
{
"nome": "Il chiosco delle banane",
"total": 250000,
"topItem":
{ "price": "4", "descrizione": "Il Gob" }
},
{
"name": "Pizza Planet",
"totale": 80000,
"topItem":
{ "prezzo": "15", "descrizione": "Pepperoni" }
}
]
?() -> [{
"nome": "Acme Store",
"total": 1000000,
"topItem":
{ "price": "50", "descrizione": "Incudine" }
}]
() -> [
{
"nome": "Pizza Planet",
"totale": 80000,
"topItem":
{ "prezzo": "15", "descrizione": "Pepperoni" }
}
] Esempio di API in Node Javascript
L’esempio che segue è un modello di base da seguire per la formattazione dei dati degli eventi.
Attenzione: L’impostazione di un evento JSON richiede conoscenze avanzate di programmazione. Sebbene il nostro team di assistenza sia lieto di aiutarvi con le basi dell’inserimento delle informazioni nell’evento, non possiamo fornire assistenza sugli aspetti di programmazione. Potete sempre provare a chiedere alla nostra comunità di utenti dedicati.
var request = require('request-promise');
var surveyId = "SV_XXXXXXXXXX";
var triggerId = "OC_XXXXXXXXX";
var brandId = "YOUR_BRAND_ID";
var userId = "UR_XXXXXXXXXXXXX";
var datacenter = "xx1";
var apiToken = "YOUR_QUALTRICS_API_TOKEN";
var url = "https://" + datacenter + ".qualtrics.com/inbound-event/v1/event/JSON/trigger" +
"?contextId=" + surveyId + "&userId=" + userId + "&brandId=" + brandId + "&triggerId=" + triggerId;
var payload = {
"text": "Questo è un testo",
"object": {
"number": 4
},
"array": ["a", "b", "c", "d"]
};
var options = {
url: url,
json: true,
body: payload,
headers: {
"Content-Type": "application/json", // OBBLIGATORIO!!!
"X-API-TOKEN": token API
}
};
request.post(options).then(function (ret) {
console.log("success:", url, payload);
}).catch(function (err) {
console.log("error: ", url);
console.log(err);
}); Esempio: Integrazione con Freshdesk
Consiglio Q: questa attività è separata da quella di Freshdesk.
L’evento JSON può essere utilizzato per l’integrazione con Freshdesk come regola Webhook in Dispatch’r. Ciò significa che gli eventi in Freshdesk possono attivare attività in Qualtrics, come la creazione di un ticket o la distribuzione di un sondaggio.
Consiglio Q: il Supporto Qualtrics può aiutarvi a configurare il vostro Evento JSON e a collegarlo tramite Freshdesk. Tuttavia, potrebbero esserci alcune domande sulle funzionalità di Freshdesk a cui non possono rispondere. Se avete domande sull’AFFIANCATO di Freshdesk, provate a consultare la documentazione sulle Regole di Dispatch.
Consiglio Q: per ulteriori informazioni sui Webhook di Freshdesk, consultare la documentazione collegata sul sito di supporto.
Esempio: Integrazione con ServiceNow
Consiglio Q: questa attività è separata da quella di ServiceNow.
L’evento JSON può essere utilizzato per integrarsi con ServiceNow. Ciò significa che gli eventi in ServiceNow possono attivare attività in Qualtrics, come la creazione di un ticket o la distribuzione di un sondaggio.
Consiglio Q: il Supporto Qualtrics può aiutarvi a configurare il vostro Evento JSON e a collegarlo tramite ServiceNow. Tuttavia, potrebbero esserci delle domande sulle funzionalità di ServiceNow a cui non possono rispondere. Se avete domande su come accedere e attivare la vostra istanza ServiceNow per sviluppatori, provate a consultare la documentazione sulle Istanze personali per sviluppatori.
Esempio: Integrazione con Microsoft Dynamics attraverso Microsoft Flow
Consiglio Q: questa attività è separata da quella di Microsoft Dynamics.
L’Evento JSON consente agli eventi di Microsoft Dynamics di attivare attività in Qualtrics, come la creazione di un ticket o la distribuzione di un sondaggio. Ad esempio, ogni volta che si elimina un account in Microsoft, è possibile distribuire al proprietario dell’account un sondaggio di Qualtrics che pone domande di uscita. (ad esempio, Ci dispiace vederti andare via! Com’è stato il tempo trascorso con noi? Come possiamo migliorare?)
Per integrare l’Evento JSON con le azioni che si svolgono in Microsoft Dynamics, è necessario eseguire l’impostazione all’interno di Microsoft Flow anziché in Dynamics. Non preoccupatevi: Microsoft Flow viene fornito gratuitamente con ogni account Microsoft Dynamics, quindi potete accedere a Flow con i vostri dati Dynamics qui.
Consiglio: il Supporto Qualtrics può aiutarvi a configurare il vostro Evento JSON e a collegarlo attraverso Microsoft Flow e Microsoft Dynamics. Tuttavia, potrebbero esserci alcune domande sulle funzionalità Microsoft a cui non possono rispondere. Se avete domande sul lato Microsoft, provate a consultare la documentazione per Flow e le risorse per Dynamics.
Consiglio Q: Microsoft Flow è preferibile per questi passaggi perché è in grado di inviare più informazioni a Qualtrics nel corpo JSON. Se si imposta questa impostazione all’interno di Microsoft Dynamics invece che in Flow, solo i campi modificati durante l’evento Dynamics saranno inviati a Qualtrics. Ad esempio, se si sceglie di effettuare il trigger in base all’aggiornamento di un record e viene modificato solo il campo “e-mail”, i campi “nome” e “indirizzo” non verranno inviati a TRIGGER, anche se questi campi vengono richiesti specificamente nel corpo del messaggio. Flow invierà a Qualtrics tutto ciò che è stato richiesto, indipendentemente dal fatto che il campo sia stato modificato nell’evento che lo ha scatenato.
Esempio: Integrazione con Genesys PureCloud
Consiglio Q: Per impostare questa integrazione, è necessario avere accesso a Genesys Cloud Architect e a Genesys Web Service Data Actions.
Utilizzando eventi JSON, è possibile integrarsi con Genesys PureCloud per inviare ai clienti un follow-up del sondaggio dopo aver completato un’interazione telefonica o via chat.
FAQs
L'evento JSON mi consente l'integrazione con _?
L'evento JSON mi consente l'integrazione con _?
- Può essere configurato per effettuare chiamate HTTP POST in uscita (ad es. webhook, applicazione personalizzata)
- Può eseguire l'autenticazione trasmettendo un token testata
- Imposta la testata Content-Type su “application/json” e formatta i corpi della richiesta come JSON valido (facoltativo per dati evento)
Quanti eventi al minuto posso fare al mio evento JSON (op_start) prima di essere strozzato?
Quanti eventi al minuto posso fare al mio evento JSON (op_start) prima di essere strozzato?
Come faccio a sapere se il flusso di lavoro dell'evento JSON non riesce?
Come faccio a sapere se il flusso di lavoro dell'evento JSON non riesce?
Che cosa sono i flussi di lavoro? / Dove sono le azioni?
Che cosa sono i flussi di lavoro? / Dove sono le azioni?
Non sono presenti modifiche alla funzionalità del flusso di lavoro come parte di questo aggiornamento.
È fantastico! Grazie per il tuo feedback!
Grazie per il tuo feedback!