Le module Q&A peut être intégré via notre API sur vos pages produits.
Pour intégrer votre module Q&A par API, suivez les indications ci-dessous :
- Depuis le menu latéral gauche de votre compte Avis Vérifiés, cliquez sur Questions & Answers.
- Cliquez ensuite sur Intégration dans le menu latéral gauche de la page qui vient de s'ouvrir.
- Cliquez sur Intégration API parmi les 3 onglets disponibles.
Il s'agit d'une intégration par API et flux JSON.
Cette intégration vous demande plus d’effort car les formulaires de questions, réponse publique et signalement sont à réaliser de votre côté.
Les formulaires d’échanges et de réponse communautaires, sont pour le moment réalisés par l’équipe Q&A.
L’avantage de cette méthode d’intégration est une plus grande maîtrise sur l'outil Q&A.
L’API Q&A vous permet quatre fonctionnalités :
- Poser une question
- Apporter une réponse publique
- Signaler une réponse
- Voter pour une question ou une réponse
Le dépôt de réponse communautaire se fait par lien dans le mail qui sonde la communauté. Les échanges sont soumis à la même contrainte. Une documentation en ligne de l’API est disponible ici.
Tous les appels à l’API sont à effectuer en POST. Tous les retours de l’API sont en JSON.
Vous devez inclure dans vos formulaires de création de question, réponse publique et signalement le texte suivant : "J'accepte <a href="https://www.avis-verifies.com/index.php?page=mod_conditions_utilisation" target="_blank" style='font-weight: bold'>les Conditions Générales d'Utilisation</a> et <a href="https://www.avis-verifies.com/index.php?page=mod_regles_confidentialites" target="_blank" style='font-weight: bold'>la Politique de Confidentialité</a> de Avis Vérifiés."
Poser une question
{{idWebsite}} : votre identifiant Avis-Vérifiés (obligatoire)
{{productId}} : l'identifiant du produit de la page courante (obligatoire)
{{token}} : correspond à un hash sha1 de votre identifiant Site Web et de votre clef secrète (obligatoire)
{{query}} : action que doit effectuer l’API, ici ce paramètre vaut : « addQuestion » (obligatoire)
{{firstName}} : prénom ou pseudo de la personne ayant posé la question (obligatoire)
{{lastName}} : nom de la personne ayant posé la question
{{email}} : email de la personne ayant posé la question (obligatoire)
{{category}} : permet d'attribuer une catégorie à la question
{{productPage}} : permet de sauvegarder la fiche produit afin qu'elle soit disponible depuis le BackOffice
{{title}} : titre de la question (obligatoire)
{{question}} : contenu de la question (obligatoire)
{{gcuCheck}}: Acceptation de nos CGU et Politiques de Confidentialités. Valeurs acceptées : true / false (booléen) (obligatoire).URL : //qr.netreviews.eu/apiForm.php
Retours
Le code d’erreur varie en fonction du type d’erreur par exemple lors d’une erreur de paramètre, le code sera « 0X0000003 ». {{ERROR MESSAGE}} dépend lui aussi du type d’erreur, avec le même exemple, le message sera : « INVALID PARAMETERS ».
En cas de succès, l’utilisateur recevra un mail de validation pour confirmer son email. Cette étape est obligatoire pour que les éléments soient disponibles dans le back-office.
Apporter une réponse publique
{{idWebsite}} : votre identifiant Avis-Vérifiés (obligatoire)
{{token}} : correspond à un hash sha1 de votre identifiant Site Web et de votre clef secrète (obligatoire)
{{query}} : action que doit effectuer l’API, ici ce paramètre vaut : « addPublicAnswer» (obligatoire)
{{firstName}} : prénom ou pseudo de la personne ayant déposé la réponse (obligatoire)
{{lastName}} : nom de la personne ayant déposé la réponse
{{email}} : email de la personne ayant déposé la réponse (obligatoire)
{{uuid}} : uuid de la question (obligatoire)
{{text}} : contenu de la réponse (obligatoire)
{{gcuCheck}}: Acceptation de nos CGU et Politiques de Confidentialités. Valeurs acceptées : true / false (booléen) (obligatoire).URL : //qr.netreviews.eu/apiForm.php
Retours :
{success: true, code: "0X0000000", message: " OPERATION SUCCESSFUL YOU WILL RECEIVE A VALIDATION MAIL"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}Le code d’erreur varie en fonction du type d’erreur par exemple lors d’une erreur de paramètre, le code sera « 0X0000003 ». {{ERROR MESSAGE}} dépend lui aussi du type d’erreur, avec le même exemple, le message sera : « INVALID PARAMETERS ».
En cas de succès, l’utilisateur recevra un mail de validation pour confirmer son email. Cette étape est obligatoire pour que les éléments soient disponibles dans le back-office.
Signaler une réponse
{{idWebsite}} : votre identifiant Avis-Vérifiés (obligatoire)
{{token}} : correspond à un hash sha1 de votre identifiant Site Web et de votre clef secrète (obligatoire)
{{query}} : action que doit effectuer l’API, ici ce paramètre vaut : « addReport» (obligatoire)
{{firstName}} : prénom ou pseudo de la personne ayant posé le signalement (obligatoire)
{{lastName}} : nom de la personne ayant posé le signalement
{{email}} : email de la personne ayant posé le signalement (obligatoire)
{{uuid}} : uuid de l’élément à signaler (obligatoire)
{{text}} : contenu de la réponse (obligatoire)
{{gcuCheck}}: Acceptation de nos CGU et Politiques de Confidentialités. Valeurs acceptées : true / false (booléen) (obligatoire).URL : //qr.netreviews.eu/apiForm.php
Retours :
{success: true, code: "0X0000000", message: " OPERATION SUCCESSFUL YOU WILL RECEIVE A VALIDATION MAIL"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}Le code d’erreur varie en fonction du type d’erreur par exemple lors d’une erreur de paramètre, le code sera « 0X0000003 ». {{ERROR MESSAGE}} dépend lui aussi du type d’erreur, avec le même exemple, le message sera : « INVALID PARAMETERS ».
En cas de succès, l’utilisateur recevra un mail de validation pour confirmer son email. Cette étape est obligatoire pour que les éléments soient disponibles dans le back-office.
Voter pour une question/réponse
{{idWebsite}} : votre identifiant Avis-Vérifiés (obligatoire)
{{token}} : correspond à un hash sha1 de votre identifiant Site Web et de votre clef secrète (obligatoire)
{{query}} : action que doit effectuer l’API, ici ce paramètre vaut : « vote» (obligatoire)
{{uuid}} : uuid de la question/réponse pour laquelle l’utilisateur vote (obligatoire)
{{type}} : vote positif ou négatif pour la question/réponse. Ne peut prendre que pour valeur « up » ou « down » (obligatoire)
URL : //qr.netreviews.eu/apiForm.php
Retours :
{success: true, code: "0X0000000", message: "success"}
{success: false, code: "0X000000?", message: "{{ERROR MESSAGE}}"}
{success: true, code: "0X0000000", message: "already_voted"}Le code d’erreur varie en fonction du type d’erreur par exemple lors d’une erreur de paramètre, le code sera «0X0000003». {{ERROR MESSAGE}} dépend lui aussi du type d’erreur, avec le même exemple, le message sera : « INVALID PARAMETERS ».
Il n’est possible pour un utilisateur de voter qu’une seule et unique fois, c’est pour cela que le message « already_voted » peut être retourné par l’API, indiquant que le vote avait déjà été pris en compte.