Vous avez la possibilité d'envoyer vos preuves d'achat/service en toute autonomie, grùce à la méthode d'automatisation API.
Cliquez sur la version qui correspond Ă votre menu :
Il existe d'autres méthodes d'automatisation comme SFTP ou CSV. (cliquez sur la méthode souhaitée pour accéder à la procédure)
Lexique
-
Transaction : décrit une commande, achat, location réalisée par un consommateur avec votre
enseigne. - Produit : dĂ©crit un produit tangible ou intangible qui a Ă©tĂ© consommĂ© par votre acheteur et pour lequel il va faire lâobjet dâun sondage.
Créer un compte
- Vous devez disposer d'un compte Avis Vérifiés.
- Accédez ensuite aux clés API via ces codes principaux :
| {id_website} | Identifiant unique propre à chaque compte client (clé publique) |
| {secret_key} | ClĂ© secrĂšte nous permettant dâidentifier le compte client de maniĂšre sĂ©curisĂ©e |
Puis utilisez les URLs vous concernant dans lâappel Ă nos APIs dĂ©crit dans le document « [URL] » :
Voici la liste des URLs en fonction de nos sites :
âą FR : www.avis-verifies.com
âą ES : www.opiniones-verificadas.com
âą DE : www.echte-bewertungen.com
âą IT : www.recensioni-verificate.com
âą NL : www.echte-beoordelingen.com
âą UK : www.verified-reviews.co.uk
âą US : www.verified-reviews.com
âą BR : www.opinioes-verificadas.com.br
âą PT : www.opinioes-verificadas.com
âą CO : www.opiniones-verificadas.com.co
âą PL : www.prawdziwe-opinie.com
âą MX : www.opiniones-verificadas.com.mx
Pour obtenir la liste exhaustive des URLs, rendez-vous sur notre site et utilisez la liste déroulante
permettant dâatteindre une autre langue.
Retrouver les codes d'intégration
Pour retrouver votre clé secrÚte et l'identifiant de votre site web :
- Rendez-vous dans le menu latéral gauche d'Avis Vérifiés
Gestion du compte, puis
Mon compte.
- Les informations se trouvent alors à droite de la page dans la partie Code d'intégration.
Services et données à transmettre
Avis Vérifiés permet un interfaçage simple avec une grande variété des connecteurs.
En voici la liste.
Achat en ligne, en magasin, clickncollect ou autre canal/type
Avis VĂ©rifiĂ©s permet de distinguer les achats rĂ©alisĂ©s en ligne, en magasin, en ligne avec un service de clickncollect (aussi appelĂ© webtostore) ou en magasin avec un systĂšme de commande sur tablette (aussi appelĂ© storetoweb) dans le but dâadapter lâemail et le formulaire adressĂ©s aux consommateurs.
Notion de transactions et produits
Au sein du systĂšme Avis VĂ©rifiĂ©s, une commande/transaction peut contenir un ou plusieurs produits/services vous offrant la possibilitĂ© dâinterroger vos consommateurs sur :
- Votre site/magasin/enseigne
- ET/OU Vos produits/services
Sonder vos clients avec un délai / Sonder vos clients en deux fois
Pour obtenir de la part de vos clients un avis pertinent en fonction de son expérience de
consommation, vous pouvez les interroger en utilisant un dĂ©lai avant Ă©mission de la demande dâavis
qui sâapplique Ă rĂ©ception de la transaction par nos services. Ce dĂ©lai est paramĂ©trable depuis votre
espace client (sera appliquĂ© Ă toutes les commandes) ou peut ĂȘtre gĂ©rĂ© par commande en indiquant
ce dĂ©lai lors de lâenvoi des donnĂ©es vers nos services.
Ăgalement, il est possible de dissocier la demande dâavis enseigne de la demande dâavis produit dans
deux emails diffĂ©rĂ©s (attention, des surcoĂ»ts peuvent sâappliquer, consultez votre chargĂ© de compte)
Sonder vos clients par SMS (selon offre commerciale)
Vous pouvez sonder vos clients via SMS, pour cela, vous devez vous rapprocher de votre chargé de
compte.
Données à transmettre
Ci-dessous la liste exhaustive des données prévues par le standard Avis Vérifiés. Certaines de ces
donnĂ©es ne sâappliquent que pour un type de transfert (API, CSV etc âŠ).
Le tableau ci-dessous décrit les données qualifiant la transaction. Ces données permettent à Avis
Vérifiés de sonder un client sur notre expérience de votre enseigne uniquement.
| Field | Content | Required |
|---|---|---|
| query | pushCommandeSHA1 | yes, only if API call |
| order_ref | order reference | yes |
| customer email | yes | |
| phone | customer phone number (format : 33614556699) | no |
| order_date | order date (YYYY-MM-DD hh:mm:ss OR YYYY-MM-DD) | yes |
| firstname | customer firstname | yes |
| lastname | customer lastname | yes |
| canal | online, offline, clickncollect (should be validated by Verified Reviews) | no |
| id_shop | id of the shop | no |
| name_shop | name of the shop | no |
| delay | delay before sending the reviews request (in days) | no |
| delay_product | delay before sending the reviews request related to products (in days). Must be the same for all the products of the same order_ref. Must be different and higher than âdelayâ |
no |
| sign | signature to authentify the request | yes, only if API call |
Extra données relatives à la transaction :
Avis VĂ©rifiĂ©s vous permet, en plus des donnĂ©es standards prĂ©vues, de qualifier vos transactions avec toutes les donnĂ©es propres Ă votre organisation. Par exemple, pour identifier facilement lâauteur dâun avis au sein des outils Avis VĂ©rifiĂ©s, vous pouvez ajouter son identifiant propre Ă votre systĂšme. Pour ce faire, vous devez communiquer Ă votre interlocuteur Avis VĂ©rifiĂ©s la liste en prĂ©cisant leur type et le caractĂšre requit de la donnĂ©e. Si une donnĂ©e requise est absente, la commande sera refusĂ©e.
Ci-dessous un exemple :
| Field | Type | Required |
|---|---|---|
| external_client_id | string | no |
| type_delivery | string example: laposte, relay ⊠|
yes |
| civility_customer | string example: Mr, Mme etc ⊠|
yes |
Dans cet exemple, type_civility_customer est rendu obligatoire car il est affichĂ© au sein de lâemail de demande dâavis « Bonjour Mr Dupont ».
Le tableau ci-dessous décrit les données qualifiant les produits associés à la transaction. Ces données permettent à Avis Vérifiés de compléter le sondage sur votre enseigne avec les produits consommés.
| Field | Content | Required |
|---|---|---|
| id_product | id of the product | yes |
| name_product | name of the product | yes |
| url_product | absolute URL of the product | yes (only if you want us to provide the reviews related to your products to Google Shopping) |
| url_image_product | absolute URL of the product image | yes (only if you want us to provide the reviews related to your products to Google Shopping. The image will be displayed on the survey) |
| GTIN_EAN | product EAN | yes* (only if you want us to provide the reviews related to your products to Google Shopping)* |
| GTIN_UPC | product UPC | no* |
| GTIN_JAN | product JAN | no* |
| GTIN_ISBN | product ISBN | no* |
| MPN | product MPN | no* |
| sku | product SKU | yes* (only if you want us to provide the reviews related to your products to Google Shopping) |
| brand_name | product brand name | no, but highly recommended to display the reviews on Google Shopping |
Il est indispensable de nous envoyer au moins une des données GTIN_EAN, GTIN_UPC,
GTIN_IAN, GTIN_ISBN, MPN, sku pour permettre Ă Google de rapprocher nos avis avec vos produits
sur Google Shopping
Note importante concernant Google Shopping : afin dâassocier les avis collectĂ©s avec Avis VĂ©rifiĂ©s aux produits que vous transmettez Ă Google Shopping via des flux, il est important que les donnĂ©es envoyĂ©es Ă Google soient identiques Ă celles qui nous sont transmises (EAN, SKU, brand, GTIN âŠ). Dans le cas
contraire, vous serez averti par Google de la non-correspondance des avis transmis par nos
services avec les produits quâil connait de votre site.
Envoyer vos transactions par API/Webservice
Les transactions peuvent ĂȘtre transmises Ă Avis VĂ©rifiĂ©s par diffĂ©rentes mĂ©thodes, cette partie dĂ©crit
la méthode API/WebService.
Ămettre une requĂȘte
Voici lâURL de lâAPI : https://[URL]/index.php?action=act_api_notification_sha1&type=json2
Structure et envoi de la requĂȘte :
La requĂȘte doit ĂȘtre structurĂ©e dans un tableau et envoyĂ©e via une requĂȘte HTTP POST :
| idWebsite | Votre identifiant client technique |
| message | Tableau des donnĂ©es dĂ©crites ci-dessus, doit ĂȘtre json_encode |
Appel API :
Ci-dessous les donnĂ©es Ă envoyer via API en veillant Ă ce que le tableau âmessageâ doit encodĂ© en
JSON.
{
"idWebsite": "fd5445fb-4468-4947-adb6-5051429d88ad",
"message": {
"order_ref": "ref100",
"firstname": "John",
"lastname": "Doe",
"email": "john@doe.com",
"order_date": "2019-01-01 12:00:00",
"sign": "5051429d88addsd65247zaedesdw5sdsz561s92eis",
"PRODUCTS": {
"0": {
"id_product": 100,
"name_product": "My Product 100"
},
"1": {
"id_product": 200,
"name_product": "My Product 200"
}
}
}
}Calcul de la signature :
La signature est calculée avec la méthode SHA1 à partir de la concaténation de certaines données
passĂ©es au sein du tableau message auquel nous rajoutons votre {secret_key}. La signature doit ĂȘtre
intĂ©grĂ©e au tableau âmessageâ, elle permet dâautoriser lâappel API.
Lâensemble des donnĂ©es devront ĂȘtre « url encodĂ©e » et encodĂ©es en UTF-8 prĂ©alablement.
| sign | SHA1(âqueryâ + âorder_refâ + âemailâ + âlastnameâ + âfirstnameâ + âorder_dateâ + âdelayâ + âsecret_keyâ) |
Précision :
âsignâ est la concatĂ©nation des donnĂ©es âqueryâ + âorder_refâ + âemailâ + âlastnameâ + âfirstnameâ +
âorder_dateâ + âdelayâ + âsecret_keyâ, le tout encodĂ© en SHA1. delay ne doit ĂȘtre ajoutĂ© dans le calcul
que sâil est prĂ©sent dans les donnĂ©es. Les + dĂ©crivent la concatĂ©nation, ils ne doivent pas ĂȘtre
ajoutés dans le calcul.
En retour, il vous faudra vérifier la conformité du message.
Décoder un message de retour
Les informations en retour vous sont transmises directement au sein dâun tableau. Vous devez
décoder le message retourné en JSON.
Liste des codes retours :
| 1 | Votre action a été effectuée avec succÚs |
| 2 | Le calcul de la signature ne donne pas le mĂȘme rĂ©sultat |
| 3 | Le compte client (idWebsite) n'a pas été identifié |
| 4 | Les paramĂštres sont incorrects |
Récupérer le lien du formulaire SANS envoyer la demande d'avis
Rapprochez-vous de votre chargĂ© de compte pour autoriser lâaccĂšs Ă cette API.
En ajoutant le paramĂštre noEmail=true Ă la fin de lâurl de lâAPI, la demande dâavis ne sera pas
envoyĂ©e, mais lâAPI retournera lâurl de la demande dâavis gĂ©nĂ©rĂ©e dans le cas oĂč lâenvoi de lâemail
doit ĂȘtre gĂ©rĂ© par vos services.
Envoyer vos commandes par export CSV sur SFTP
Les transactions peuvent ĂȘtre transmises Ă Avis VĂ©rifiĂ©s par diffĂ©rentes mĂ©thodes, cette partie dĂ©crit
la méthode par export CSV déposé sur un FTP/SFTP.
Un accÚs SFTP vous est dédié et vous permet de déposer, à intervalle que vous souhaitez un fichier
CSV contenant les commandes pour lesquelles nous devons envoyer des demandes dâavis. Le SFTP
est lu une fois par jour (entre 1h et 3h du matin) par notre systÚme afin de consommer les données du
ou des fichiers déposés.
Format du fichier
| Encodage | UTF8 â No Bom |
| Délimiteur | ; (semi-colon separator) |
Retrouvez les données à transmettre dans les parties précédentes.
Structure du dossier SFTP
Vous devez dĂ©poser vos fichiers CSV dâexport dans le dossier /orders. Le dossier /success va recevoir les fichiers qui ont Ă©tĂ© correctement traitĂ©s par notre systĂšme tandis que le dossier /error va recevoir les fichiers qui nâont pas Ă©tĂ© lu correctement par notre systĂšme.
Lorsque le fichier est déplacé dans un dossier /success ou /error, le nom de celui-ci est complété avec la date de traitement. (export-orders-20140902.csv devient export-orders20140902_date_2014-06-11_16-34-18.csv)
Voici la structure du fichier à déposer :
- Télécharger un exemple avec produit
- Télécharger un exemple sans produit
- Télécharger un exemple cas OFFLINE avec produit
- Télécharger un exemple cas OFFLINE sans produit
La liste exhaustive des champs disponibles se trouve plus haut dans ce document.
Vérifier votre fichier
Pour vérifier le format du fichier, rendez-vous dans « Intégration > Application > Test CSV file ».
Envoyer vos commandes par Google Tag Manager
Prérequis
- Au préalable avoir un compte sur Google Tag Manager et avoir installé la balise GTM sur votre site : https://tagmanager.google.com
- Nous vous conseillons vivement de lire la documentation officielle afin de savoir comment utiliser ce service : (https://www.google.fr/analytics/tag-manager/).
En intĂ©grant lâautomatisation via GTM, vous ne pourrez pas gĂ©rer lâenvoi des donnĂ©es de commandes vers nos services en fonction dâun statut de commandes, les donnĂ©es nous parvenant dĂšs finalisation de la commande par le client.
Création des variables
Sur lâadministration GoogleTagManager, vous devez crĂ©er 7 variables, pour ce faire :
- Rendez-vous dans la rubrique Variables
- Dans la partie Variables définies par l'utilisateur, cliquez sur Nouveau, choisissez le type Variable de couche de données et remplissez simplement le nom de la variable en laissant les autres paramÚtres par défaut (notamment version 2 de la couche de données).
- Vous devez créer 7 variables de type variables de couche de données :
âą netreviews.idWebsite
âą netreviews.order_ref
âą netreviews.firstname
âą netreviews.lastname
âą netreviews.email
âą netreviews.products
âą netreviews.token
Création du déclencheur
Sur lâadministration GoogleTagManager :
- Cliquez sur la rubrique Déclencheurs, puis sur le bouton Nouveau.
- Remplissez le déclencheur comme suit :
âą Choisissez lâĂ©vĂšnement « Page vue »
âą Choisissez le type de dĂ©clencheur « DOM prĂȘt » - Configurez votre filtre de maniĂšre Ă cibler la page souhaitĂ©e : Elle doit ĂȘtre la page qui confirme la commande, et doit contenir les donnĂ©es relatives Ă la commande et Ă lâacheteur.
Création de la balise
Dans lâadministration GoogleTagManager :
- Rendez-vous sur la rubrique Balises
- Cliquez sur Nouvelle.
-
Remplissez ensuite le formulaire comme suit :
âą Choisissez le produit « Balise HTML personnalisĂ©e » (bouton en bas du lien âPlusâ)
⹠Collez le script suivant : Exemple Script<script type="text/javascript"> var iframe= document.createElement("iframe"); iframe.style = "border:0; height:0; width:0;"; iframe.src = "//[URL]/index.php?action=act_google_tag_manager"; iframe.src += "&idWebsite="+{{netreviews.idWebsite}}+"&order_ref="+{{netreviews.orderRef}} +"&firstname="+{{netreviews.firstname}}+"&lastname="+{{netreviews.lastname}} +"&email="+{{netreviews.email}}+"&token="+{{netreviews.token}}; if(typeof {{netreviews.products}} != "undefined" && {{netreviews.products}} != null && {{netreviews.products}}.length > 0) iframe.src += "&products="+encodeURIComponent(JSON.stringify({{netreviews.products}})); document.body.appendChild(iframe); </script> - Choisissez le déclencheur précédemment créé.
Ajout des données dynamiques
Dans le code HTML de votre page de confirmation, ajoutez les données dans le dataLayer :
<script type="text/javascript">
window.dataLayer = window.dataLayer || [];
dataLayer.push({
'netreviews' : {
'idWebsite' : 'XXXXXXXX-1234-abcd-5678-XXXXXXXXXXXX',
'order_ref' : '12345',
'firstname' : 'John',
'lastname' : 'Doe',
'email' : 'john@doe.com',
'products' : [{
'name_product' : 'product_name_1',
'id_product' : 'REF_01'
},{
'name_product' : 'product_name_2',
'id_product' : 'REF_02',
'url_product' : 'http://www.shop.com/product2',
'url_image_product' : 'http://www.shop.com/product2/image.png',
'GTIN_EAN' : '6598745632153'
}],
'token' : 'VOTRE_TOKEN'
}
});
</script>Le token est une clé encryptée obligatoire pour des raisons de sécurité, générée comme suit : sha1(idWebsite . cleSecrete . order_ref)
Notez bien quâĂ part lâidWebsite statique que vous pouvez rĂ©cupĂ©rer sur votre compte Avis-VĂ©rifiĂ©s,
tous les paramÚtres sont à inclure dynamiquement. Les points décrivent le caractÚre de concaténation
et ne doivent donc pas composer le token.
Récupérer vos avis
Avis Vérifiés propose différentes méthodes pour récupérer les avis collectés. Ces différentes méthodes permettent une intégration simple au sein de vos outils laissant le choix à votre équipe de la méthode la plus adaptée à leur infrastructure.
La rĂ©cupĂ©ration dâavis peut servir diffĂ©rents objectifs :
- Analyse de données par des data analyst
- Affichage publique des avis
- Affichage interne des avis
Principe de fonctionnement et données disponibles
Une interface vous permet de paramétrer la récupération des avis produits et avis enseigne via différentes méthodes présentées ci-dessous.
1. Données standards
Voici la liste exhaustive des données standards, quelques précisions :
-
la donnée « action » sera uniquement présente dans les fichiers de synchronisation, elle
nâest pas prĂ©sente dans les ressources Web - en orange, les donnĂ©es prĂ©sentes uniquement dans le flux avis produit.
| Label | Value | Comment |
|---|---|---|
| action | NEW | new review |
| action | UPDATE | new message on a review |
| action | DELETE | review has been refused. Only in synchronization files, webressources will not contain âactionâ data |
| review_id | UUID 36 characters | unique identifier of the review in our database |
| product_review_id | UUID 36 characters | unique identifier of the product review in our database |
| client email | ||
| lastname | client lastname | |
| firstname | client firstname | |
| review_date | review date | |
| review | review content | |
| rate | review rate | |
| order_ref | your order reference | |
| product_ref | your product reference | |
| nb_comments | nombre of messages on the review | Only for CSV format. If 0, new columns will be added, group of 3 columns by message (details below) |
| date | date of the message | |
| author | author of the message | 2 = you, 3 = client |
| comment | message |
2. Données non standards
Comme Ă©voquĂ© prĂ©cĂ©demment dans la partie « donnĂ©es transmises », Avis VĂ©rifiĂ©s vous permet de renseigner des donnĂ©es propres Ă votre organisation au sein des donnĂ©es de transactions. Ces donnĂ©es peuvent ĂȘtre restituĂ©es au sein des flux de sortie via le mĂȘme label que celui-ci dâentrĂ©e. Pour ce faire, rendez-vous dans lâonglet « Personnalisation â Avis Site/produit ».
Cette interface permet dâajouter et donner un nom aux donnĂ©es en sortie.
Nous vous recommandons de nous contacter avant dâutiliser cette configuration. Si votre Ă©quipe technique a dĂ©jĂ intĂ©grĂ© la lecture de nos flux de donnĂ©es, vous devez les avertir avant tout changement. Dans le cas contraire, la consommation des donnĂ©es peut ĂȘtre perturbĂ©e.
Récupérer les avis via des fichiers de synchronisation
Fonctionnement :
-
Rendez-vous dans lâonglet « Configuration » pour sĂ©lectionner les flux de donnĂ©es souhaitĂ©s et configurer le FTP/SFTP de destination.
â Nous pouvons crĂ©er une FTP/SFTP sur nos serveurs si besoin, contactez-vous.Toutes les nuits (entre 1h et 3h heure FRANCE) nous dĂ©posons sur le compte FTP que vous aurez prĂ©alablement paramĂ©trĂ© ci-dessous, un fichier CSV ou XML contenant les nouveaux avis enseigne et/ou Produit, les mises Ă jour des avis enseigne et/ou Produit ainsi que les suppressions des avis enseigne et/ou Produit de la veille.
Les deux formulaires sont similaires et vous permettent de récupérer différemment les avis enseigne des avis produit.
Label Value Comment Format CSV / XML Nous vous proposons deux formats CSV et XML. Ces deux formats seront explicitĂ©s dans la suite de ce document MĂ©thode de transfert FTP / SFTP Nous mettons Ă disposition deux mĂ©thodes de transfert de fichier FTP et SFTP. Attention, modifiez le Port en fonction de votre serveur. Serveur Adresse IP ou Host DĂ©finition de lâadresse IP ou du Host sur lequel nous allons nous connecter Identifiant Login Identifiant de connexion Ă votre serveur FTP/SFTP (nous devons avoir les droits dâĂ©criture) Mot de passe Password Mot de passe dâaccĂšs Ă votre compte FTP/SFTP Port NumĂ©ro Port dâĂ©coute de votre service FTP/SFTP Chemin du rĂ©pertoire Path Chemin dans lequel nous allons dĂ©poser vos fichiers - « Tester la connexion » : Tester immĂ©diatement que nous arrivons Ă nous connecter sur votre compte FTP/SFTP. (Nous ne vĂ©rifions pas les droits dâĂ©criture).
- «Test the reviews feed » : Envoyer immédiatement un flux de données vers le FTP/SFTP (quotidien ou intégral).
Interpréter une action NEW, DELETE et UPDATE :
Chaque ligne (ou nĆud XML) des fichiers de synchronisation possĂšde un type indiquant lâaction a effectuĂ© au sein de votre base de donnĂ©es :
| NEW | Nouvel avis publié, vous devez ajouter cet avis à votre base de données |
| UPDATE | Lâavis a subi une modification, toutes les donnĂ©es de lâavis (donnĂ©es personnelles de lâacheteur, son avis, les rĂ©ponses sur lâavis) doivent ĂȘtre mise Ă jour, cas dâexemple une rĂ©ponse a Ă©tĂ© apportĂ©e Ă lâavis par lâenseigne ou le client. â Si le consommateur nous demande lâanonymisation de ses donnĂ©es personnelles, les informations seront remplacĂ©es par Anonymous |
| DELETE | Lâavis a Ă©tĂ© dĂ©finitivement refusĂ©, vous devez retirer cet avis de votre base de donnĂ©es. |
Format CSV :
| Encodage | UTF8 Sans Bom |
| Séparateur | tabulation (\t) |
Format XML :
| Encodage | UTF8 Sans Bom |
Toutes les donnĂ©es sont encapsulĂ©es entre les balises CDATA afin de ne pas ĂȘtre bloquĂ© par les caractĂšres spĂ©ciaux.
Nommage des fichiers :
Les fichiers « avis enseigne » sont nommés en respectant le format suivant :
| Incremental | reviews_site_<idWebsite>_<date>.<file_type> |
Les fichiers « avis produits » sont nommés en respectant le format suivant :
| Incremental | reviews_product_<idWebsite>_<date>.<file_type> |
| date | date du dépÎt au format YYYYMMDD |
| field_type | type du fichier csv ou xml |
| idWebsite | your account idWebsite |
Exemples :
- reviews_598b6360-e762-cf54-790a-85cfdcb0bdc1_20130523.csv
- reviews_product_598b6360-e762-cf54-790a-85cfdcb0bdc1_20130523.xml
Via des ressources Web
Vous pouvez utiliser les ressources Web accessibles via le protocole http ou https. Ces ressources sont mises Ă jour chaque nuit entre 1h et 3h du matin.
Une mise en cache des donnĂ©es rĂ©cupĂ©rĂ©es via lâappel Ă ces ressources doit ĂȘtre mise en place cotĂ© serveur. En effet, lâaccĂšs aux donnĂ©es sera automatiquement bloquĂ© si les appels sont rĂ©alisĂ©s trop souvent (Ă©viter par exemple les requĂȘtes Ă chaque rafraichissement de vos pages).
Les fichiers sont générés toutes les nuits, en revanche si vous venez d'activer la génération, merci de patienter de quelques minutes.
Fonctionnement des ressources Web Avis Produit
Nous mettons Ă votre disposition plusieurs ressources ayant des objectifs diffĂ©rents, toutes disponibles sous 3 formats XML, JSON et CSV. Rendez-vous dans lâonglet « API produit » pour activer leur gĂ©nĂ©ration.
Nous ne connaissons vos produits que sâils ont transitĂ©s via vos exports de commandes. Si votre produit est inconnu, vous obtiendrez une erreur « fichier introuvable ». Pour Ă©viter cela, faites en sorte de consulter en amont la ressource dĂ©crite plus bas « Obtenir la liste des produits ayant au moins un avis ainsi que la date de mise Ă jour ».
Obtenir la note moyenne et nombre dâavis via un fichier contenant tous les produits
Cette ressource liste tous les id_product ayant au moins un avis et indique sa note sur et nombre dâavis. Utilisez cette ressource pour afficher les notes sur une liste de produits par exemple.
Exemple JSON :
{
"3819": {
"id_product": "3819",
"rate": "5",
"nb_reviews": "1"
},
"50404": {
"id_product": "50404",
"rate": "1",
"nb_reviews": "1"
}
} URL d'accĂšs : //cl.avis-verifies.com/code_lang/cache/x/x/x/xxxxxxx-x-x xxxxxxxxxx/AWS/PRODUCT_API/AVERAGE/all_products.[format]
Obtenir la note moyenne et nombre dâavis par produit, un fichier par produit
Ces ressources identifiĂ©es par id_product permettent dâobtenir la note et nombre dâavis dâun produit.
Utilisez cette ressource pour afficher la note et nombre dâavis dâun produit dans la partie supĂ©rieure de la fiche produit ou pour alimenter vos contenus enrichis (rich-snippets) par exemple.
Exemple JSON :
{
"rate": "1",
"count": "1"
}URL d'accĂšs : //cl.avis-verifies.com/code_lang/cache/x/x/x/xxxxxxx-x-x-xxxxxxxxxx/AWS/PRODUCT_API/AVERAGE/[id_product].[format]
Obtenir la liste des avis par produit, un fichier par produit
Ces ressources listent les avis collectés sur un produit que vous pouvez afficher publiquement. Ces avis ont passé nos filtres de modération et sont anonymisés (1Úre lettre du nom et prénom). Utilisez cette ressource pour afficher les avis sur une fiche produit.
Pour un exemple, rendez-vous sur votre espace client.
URL dâaccĂšs : //cl.avis-verifies.com/code_lang/cache/x/x/x/xxxxxxx-x-x-xxxxxxxxxx/AWS/PRODUCT_API/REVIEWS/[id_product].[format]
Obtenir la liste des produits ayant au moins un avis ainsi que la date de mise Ă jour
Cette ressource (CSV uniquement) liste les produits ayant au moins un avis ainsi que sa date de derniĂšre mise Ă jour. Utilisez cette ressource pour connaitre la liste des produits ayant des avis avant dâappeler une des ressources dĂ©crites ci-dessus. La date de derniĂšre mise Ă jour vous permet de mettre Ă jour votre cache local uniquement si le produit a subi un changement de note ou nombre dâavis.
50404;2017-08-23
10;2017-08-23
URL d'accĂšs : //cl.avis-verifies.com/code_lang/cache/x/x/x/xxxxxxx-x-x-xxxxxxxxxx/AWS/PRODUCT_API/AVERAGE/files_list.txt
Fonctionnement des ressources Web Avis enseigne
- Rendez-vous dans lâonglet « API Site ». Retrouvez les URLS dâaccĂšs aux fichiers et des
exemples depuis cette interface. - Activer la gĂ©nĂ©ration dâun fichier contenant la liste des avis publiĂ©s
- Choisissez la plage de dates, de 1 Ă 12 mois.
Formats disponibles : JSON, XML, CSV, RSS
URL dâaccĂšs : //cl.avis-verifies.com/code_lang/cache/x/x/x/xxxxxxx-x-x-xxxxxxxxxx/AWS/WEBSITE_API/reviews.[format]
[format] correspond au format de fichier utilisé : .json, .xml, .csv ou .rss
Fonctionnement des ressources Web Avis Magasin
Si des magasins sont rĂ©fĂ©rencĂ©s dans votre compte Avis VĂ©rifiĂ©s, le lien suivant vous permet dâobtenir la note moyenne et nombre dâavis de chaque magasin.
- id_shop : identifiant du magasin
- name_shop : nom du magasin
- review_number : nombre dâavis publiĂ©s pour ce magasin
- rating : note obtenue (4 chiffres aprĂšs la virgule)
- certificate_url : URL du certificat
URL d'accĂšs : //cl.avis-verifies.com/code_lang/cache/x/x/x/xxxxxxx-x-x-xxxxxxxxxx/AWS/xxxx_infoshops.txt
Via API
Avis VĂ©rifiĂ©s met Ă disposition une API permettant de filtrer le contenu des webressources dĂ©crites prĂ©cĂ©demment. De ce fait, les webressources doivent ĂȘtre activĂ©es pour bĂ©nĂ©ficier de cette API.
Avis enseigne
https://awsapis3.netreviews.eu/website
Voici la liste des paramĂštres GET permettant de filtrer :
| GET Params | Description | Required |
|---|---|---|
| idWebsite | Identifiant Avis Vérifiés du compte marchand, 36 caractÚres | Oui |
| format | The format of the input data (webressource) | Yes, âjsonâ only |
| iso_code | Country, for example fr, it, es, etc. | No, âfrâ if empty |
| order_type | Sort results on a value, all the values are available to sort | No, âreview_dateâ if empty |
| order_by | Sort or filter results. âą Use âascâ or âdescâ to sort âą Use âequalâ, âsupâ or âinfâ to filter âą Add parameter âcompareâ in order to define the value Some examples below |
No |
| range | Number of reviews by âpageâ | No, 100 if empty |
| p | Current page | No, 0 if empty |
Exemples pour lister les avis enseigne :
- Trier par date de lâavis
- 200 résultats de la page 3 (page=2)
https://awsapis3.netreviews.eu/website?idWebsite=xxxxxxxx&format=json&order_by
- Sur Opiniones Verificadas (plateforme espagnole)
- Filtrer par store_id=503
- 200 premiers résultats
https://awsapis3.netreviews.eu/website?idWebsite=xxxxxxxx&format=json&iso_code
Avis produit
https://awsapis3.netreviews.eu/product
Vous devez effectuer un appel de type POST ou GET en renseignant un tableau JSON contenant tous les paramĂštres requis. Voici ci-dessous la liste des paramĂštres permettant de contacter lâAPI.
Pour obtenir les notes moyennes et le nombre dâavis de chaque produit :
| Params | Description | Required |
|---|---|---|
| idWebsite | Identifiant Avis Vérifiés du compte marchand, 36 caractÚres | Yes |
| query | "average" | Yes |
| plateforme | Country, for example fr, it, es, etc. | No, âfrâ if empty |
| products | ["SKU12","SKU13",...] ou "all" | Yes |
Exemple de requĂȘte :
{
"idWebsite": "xxxxx-xxxxxx-xxxxxxx-xxxxxxx",
"query": "average",
"plateforme": "fr",
"products": "all"
}
Pour obtenir la liste des avis dâun produit :
| Params | Description | Required |
|---|---|---|
| idWebsite | Identifiant Avis Vérifiés du compte marchand, 36 caractÚres | Yes |
| query | "reviews" | Yes |
| plateforme | Country, for example fr, it, es, etc. | No, âfrâ if empty |
| product | "SKU12" | Yes |
| order | Sort reviews: âdate_ascâ, âdate_descâ, ârate_ascâ, ârate_descâ, âmost_helpfulâ | No |
| filter | Filter by rate [1-5] | No |
| offset | Number of the first reviews (integer) | No |
| limit | Number of reviews to get (integer) | No |
Exemple de requĂȘte :
{
"idWebsite": "xxxxx-xxxxxx-xxxxxxx-xxxxxxx",
"query": "reviews",
"plateforme": "fr",
"product": "SKU12",
"order": "date_desc",
"offset": "0",
"limit": "5"
}
Flux de délivrabilité
Vous pouvez obtenir via un flux de donnĂ©es au format CSV quotidien, la liste des emails pour lesquels nous nâavons pas pu envoyer une demande dâavis. Ce flux est dĂ©posĂ© sur un SFTP/FTP de votre choix.
Lorsquâun email retourne une erreur de type BOUNCE, nous tentons de lâenvoyer Ă
nouveau quelques jours aprĂšs. De ce fait, lâemail peut apparaitre plusieurs fois dans ce flux de
délivrabilité.
| Encodage | UTF8 â No Bom |
| Délimiteur | ; (semi-colon separator) |
| Filename | deliverability_xxxxxxxx_yyyy-mm-dd.csv |
| Label | Value | Comment |
|---|---|---|
| type | SOFTBOUNCE, HARDBOUNCE, SPAM, BLOCKED, CAPPED, UNSUBSCRIBED | |
| Client email | ||
| order_ref | Your order reference | |
| lastname | Client lastname | |
| firstname | Client firstname | |
| order_date | Order date | |
| event_date | Date of the event |
Fonctionnalité Avis Utile Oui/Non
Vous pouvez permettre aux visiteurs de votre site de juger de lâutilitĂ© des avis dĂ©posĂ©s sur vos produits. Lâinternaute a deux choix possibles : Cet avis vous a-t-il Ă©tĂ© utile ?
- Oui
- Non
Cette fonctionnalitĂ© nĂ©cessite lâutilisation dâun webservice mis Ă disposition par Avis VĂ©rifiĂ©s vous permettant de nous communiquer les votes de vos internautes et ainsi centraliser cette donnĂ©e aux cĂŽtĂ©s de vos avis sur notre plateforme.
Faire appel au webservice
Le webservice est accessible via lâURL suivante : https://[URL]/index.phpaction=act_api_product_reviews_helpful
Les paramĂštres dĂ©taillĂ©s ci-dessous doivent ĂȘtre envoyĂ©s en POST.
Vous pouvez tĂ©lĂ©charger un exemple dâappel au webservice dĂ©veloppĂ© en PHP.
Enregistrer le vote de l'internaute
Pour enregistrer le vote dâun internaute, vous devez effectuer un appel au webservice en lui passant les paramĂštres POST suivants :
| ParamĂštre | Valeur | Information | Exemple |
|---|---|---|---|
| method | create | La mĂ©thode create est utilisĂ©e pour enregistrer ou modifier le vote dâun internaute | method=create |
| idWebsite | xxxxxxxx-xxxx-xxxxxxxx-xxxxxxxxxxxx | Identifiant Avis Vérifiés du compte marchand, 36 caractÚres | idWebsite=xxxxxxxxxxxx-xxxx-xxxxxxxxxxxxxxxx |
| idProduct | xxxxxxxx-xxxx-xxxxxxxx-xxxxxxxxxxxx | Identifiant unique de lâavis produit concernĂ©, 36 caractĂšres | idProduct=xxxxxxxxxxxx-xxxx-xxxxxxxxxxxxxxxx |
| isHelpful | 1 = avis utile / 0 = avis non utile | Vote de lâinternaute | isHelpful=1 |
| ip | 127.0.0.1 | Adresse IP de lâinternaute | ip=127.0.0.1 |
| fingerPrint | xxxxxxxxxxx | Identifiant unique de lâinternaute au sein de votre environnement ou empreinte digitale du device/browser de lâinternaute. Exemple : http://valve.github.io/fingerprintjs2/ |
fingerPrint=xxxxxxxxxxx |
| sign | sha1(idWebsite+idProduct+ip+secretKey) | Signature de lâappel au webservice | sign=xxxxxxxxxxxx |
Modifier le vote de l'internaute
Pour modifier le vote de lâinternaute, il vous suffit dâeffectuer un nouvel appel Ă la mĂ©thode âcreateâ en modifiant la valeur du paramĂštre « isHelpful » pour indiquer le nouveau choix de lâinternaute.
Le paramĂštre « fingerPrint » quand Ă lui permettra de reconnaitre lâinternaute et mettre Ă jour lâavis dĂ©jĂ existant.
Annuler le vote de lâinternaute
Vous pouvez permettre Ă lâinternaute de revenir sur son vote en lâannulant tout simplement. Pour cela, vous devez effectuer un appel au webservice en lui passant les paramĂštres POST suivants :
| ParamĂštre | Valeur | Information | Exemple |
|---|---|---|---|
| method | delete | La méthode delete est utilisée pour supprimer un vote existant | method=delete |
| idWebsite | xxxxxxxx-xxxx-xxxx-xxxx | Identifiant Avis Vérifiés du compte marchand, 36 caractÚres | idWebsite=xxxxxxxxxxxx-xxxx-xxxxxxxxxxxxxxxx |
| idProduct | xxxxxxxx-xxxx-xxxx-xxxx | Identifiant unique de lâavis produit concernĂ©, 36 caractĂšres | idProduct=xxxxxxxxxxxx-xxxx-xxxxxxxxxxxxxxxx |
| ip | 127.0.0.1 | Adresse IP de lâinternaute | ip=127.0.0.1 |
| fingerPrint | xxxxxxxxxxx | Identifiant unique de lâinternaute au sein de votre environnement ou empreinte digitale du device/browser de lâinternaute | fingerPrint=xxxxxxxxxxx |
| sign | sha1(idWebsite+idProduit+ip+secretKey) | Signature de lâappel au webservice | sign=xxxxxxxxxxxx |
Méthode de calcul du paramÚtre sign
Le paramĂštre sign est utilisĂ© pour permettre Ă Avis vĂ©rifiĂ©s de contrĂŽler la provenance de lâappel au webservice, voici la mĂ©thode Ă utiliser pour gĂ©nĂ©rer ce paramĂštre en PHP : $sign = sha1($idWebsite.$idProduit.$ip.$secretKey);
La donnée secretKey correspond à la clé secrÚte Avis vérifiés du compte marchand que vous pouvez retrouver dans votre espace client via le menu « Config > Mon compte »
Retour du service
En retour Ă votre appel, le webservice vous renverra une rĂ©ponse au format JSON, vous devez tenir compte de ces retours pour ĂȘtre certain que le vote a bien Ă©tĂ© enregistrĂ© / annulĂ© selon le cas de figure.
Vous pouvez utiliser ce retour pour afficher une confirmation Ă lâinternaute par exemple.
- Retour du succĂšs
{
"success": 1,
"method": "xxxxxx",
"idWebsite": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"idProduct": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"fingerPrint": "xxxxxxx",
"isHelpful": "1",
"isActive": 1,
"message": "Merci, votre vote sera bientÎt publié."
}
2. Retour d'erreur
Exemple JSON
{
"success": 0,
"idProduct": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"errorCode": 1000,
"errorMessage": "DĂ©tail technique de lâerreur rencontrĂ©e",
"message": "Une erreur est survenue."
}
Le champ « message » prĂ©sent dans le retour du webservice peut ĂȘtre utilisĂ© pour afficher un message de confirmation Ă lâinternaute.
Vous pouvez Ă©galement choisir dâafficher votre propre message de confirmation personnalisĂ©.
Le champ « errorMessage » quant Ă lui contient le dĂ©tail technique de lâerreur rencontrĂ©e et ne doit pas ĂȘtre affichĂ© Ă lâinternaute.
Gérer vos avis via une solution tiers
Avis Vérifiés propose des connecteurs avec des solutions tiers de gestion de « voix du client » pour
vous permettre de centraliser le traitement de vos avis. A ce jour, nous disposons de connecteurs :
- SalesForce
- Zendesk
Consultez votre chargé de compte pour réaliser la configuration.