Oltre a una completa integrazione in iframe, è possibile effettuare un’integrazione tramite API e flusso JSON.
And now I'm going to tell you something very important! Pay attention to me! Questa integrazione richiede uno sforzo maggiore da parte tua, dato che i formulari di domanda, risposta pubblica e segnalazione dovranno essere da te realizzati.
I formulari delle conversazioni e delle risposte della community sono attualmente prodotti dal nostro team di sviluppo.
Il vantaggio di questo metodo di integrazione è un maggiore controllo sullo strumento Domande e Risposte.
L’API Domande/Risposte consente 4 funzionalità:
- Fare una domanda;
- Inviare una risposta pubblica;
- Segnalare una risposta;
- Votare per una domanda o una risposta.
La risposta da parte della community viene lasciata tramite un link contenuto nell’email inviata per sondare la tua community. La documentazione online dell’API è disponibile qui.
Tutte le chiamate API devono essere effettuate in POST, mentre il ritorno è in JSON.
Fare una domanda
{{idWebsite}}: l’ID Website del tuo account Recensioni Verificate (obbligatorio);
{{productId}}: l’ID del prodotto della pagina corrente (obbligatorio);
{{token}}: corrisponde a un hash (sha1) del tuo ID Website e della tua chiave segreta (obbligatorio);
{{query}}: azione che l’API deve effettuare. Il valore è: “addQuestion” (obbligatorio);
{{firstName}}: nome o nickname dell’utente che ha posto la domanda (obbligatorio);
{{lastName}}: cognome dell’utente che ha posto la domanda;
{{email}}: email dell’utente che ha posto la domanda (obbligatorio);
{{category}}: consente di assegnare una categoria alla domanda;
{{productPage}}: consente di salvare la scheda prodotto per renderla disponibile dal back-office;
{{title}}: titolo della domanda (obbligatorio);
{{question}}: contenuto della domanda (obbligatorio).
URL: https://qr.netreviews.eu/apiForm.php
Messaggio di ritorno:
{success: true, code: "0X0000000", message: " OPERATION SUCCESSFUL YOU WILL RECEIVE A VALIDATION MAIL"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}
Il codice di errore varia a seconda del tipo di errore. Ad esempio, in caso di un errore di parametro il codice sarà “0X0000003”. {{ERROR MESSAGE}} dipende anche dal tipo di errore, per lo stesso esempio il messaggio sarà “INVALID PARAMETERS”.
In caso di successo, l’utente riceverà un’email di convalida per confermare la propria email. Questo passaggio è obbligatorio affinché gli elementi siano disponibili all’interno del back-office.
Fornire una risposta pubblica
{{idWebsite}}: l’ID Website del tuo account Recensioni Verificate (obbligatorio);
{{token}}: corrisponde a un hash (sha1) del tuo ID Website e della tua chiave segreta (obbligatorio);
{{query}}: azione che l’API deve effettuare. Il valore è: “addPublicAnswer” (obbligatorio);
{{firstName}}: nome o nickname dell’utente che ha lasciato la risposta (obbligatorio);
{{lastName}}: cognome dell’utente che ha lasciato la risposta;
{{email}}: email dell’utente che ha lasciato la risposta;
{{uuid}}: UUID della domanda; è presente nel flusso JSON (obbligatorio),
{{text}}: contenuto della risposta (obbligatorio).
URL: https://qr.netreviews.eu/apiForm.php
Messaggio di ritorno:
{success: true, code: "0X0000000", message: " OPERATION SUCCESSFUL YOU WILL RECEIVE A VALIDATION MAIL"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}
Il codice di errore varia a seconda del tipo di errore. Ad esempio, in caso di un errore di parametro il codice sarà “0X0000003”. {{ERROR MESSAGE}} dipende anche dal tipo di errore, per lo stesso esempio il messaggio sarà “INVALID PARAMETERS”.
In caso di successo, l’utente riceverà un’email di convalida per confermare la propria email. Questo passaggio è obbligatorio affinché gli elementi siano disponibili all’interno del back-office.
Segnalare una risposta
{{idWebsite}}: l’ID Website del tuo account Recensioni Verificate (obbligatorio);
{{token}}: corrisponde a un hash (sha1) del tuo ID Website e della tua chiave segreta (obbligatorio);
{{query}}: azione che l’API deve effettuare. Il valore è: “addReport” (obbligatorio);
{{firstName}}: nome o nickname dell’utente che ha fatto la segnalazione (obbligatorio);
{{lastName}}: cognome dell’utente che ha fatto la segnalazione;
{{email}}: email dell’utente che ha fatto la segnalazione (obbligatorio);
{{uuid}}: UUID dell’elemento da segnalare (obbligatorio);
{{text}}: motivo della segnalazione (obbligatorio).
URL: https://qr.netreviews.eu/apiForm.php
Messaggio di ritorno:
{success: true, code: "0X0000000", message: " OPERATION SUCCESSFUL YOU WILL RECEIVE A VALIDATION MAIL"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}
Il codice di errore varia a seconda del tipo di errore. Ad esempio, in caso di un errore di parametro il codice sarà “0X0000003”. {{ERROR MESSAGE}} dipende anche dal tipo di errore, per lo stesso esempio il messaggio sarà “INVALID PARAMETERS”.
In caso di successo, l’utente riceverà un’email di convalida per confermare la propria email. Questo passaggio è obbligatorio affinché gli elementi siano disponibili all'interno del back-office.
Votare per una domanda o risposta
URL: https://qr.netreviews.eu/apiForm.php
Messaggio di ritorno:
{success: true, code: "0X0000000", message: "success"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}
{success: true, code: "0X0000000", message: "already_voted"}
Il codice di errore varia a seconda del tipo di errore. Ad esempio, in caso di un errore di parametro il codice sarà “0X0000003”. {{ERROR MESSAGE}} dipende anche dal tipo di errore, per lo stesso esempio il messaggio sarà “INVALID PARAMETERS”.
Un utente può votare una domanda/risposta una sola volta e per questo motivo il messaggio “already_voted” può essere restituito dall’API, indicando che il voto era già stato preso in considerazione.