API publique – Avis | Société des Avis Garantis

Utilisation

L'API publique permet de générer des affichages et widgets directement sur votre site sans que vous stockiez les avis.
Contrairement à l'API privée, elle ne contient pas les informations personnelles des clients (nom, email, numéro de commande...).

Quotas d'utilisation : illimités

Mise en cache par CDN, cette API peut être appelée directement en ajax depuis votre site.
Authentification : non

Cette API ne dispose pas d'authentification car elle ne renvoie pas de données sensibles.
Nombre de résultats : 1000 max

L'API renvoie jusqu'à 1000 avis par requête, triés par ordre décroissant de date.
Temps de réponse moyen : 30 ms

L'API publique est optimisée pour avoir des temps de réponse permettant un affichage fluide des widgets.

Paramètres de la requête

Les paramètres suivants doivent être utilisés pour personnaliser la requête :

public_key string, obligatoire

Clé publique unique pour accéder à l'API
scope string, obligatoire

Type de données demandées. 'site' ou ID produit numérique.

Endpoint
https://api.guaranteed-reviews.com/public/v3/reviews/{YOUR_PUBLIC_KEY}/{SCOPE}

Exemple d'appel
https://api.guaranteed-reviews.com/public/v3/reviews/{YOUR_PUBLIC_KEY}/site

Valeurs retournées par l'API

L'API retourne une réponse contenant un objet 'ratings' et un objet 'reviews'.

Ratings

L'objet 'ratings' fournit un résumé des notes :

total integer

Le nombre total d'avis.
average float

La note moyenne attribuée.
distribution array

La répartition des notes entre 1 et 5.

Reviews

L'objet 'reviews' est une liste d'avis avec les informations suivantes pour chaque avis :

id integer

L'identifiant unique de l'avis.
c string

Le prénom et la première lettre du nom du client.
r integer

La note attribuée au produit (de 1 à 5).
txt string

Le texte de l'avis laissé par le client.
date string

La date à laquelle l'avis a été publié (format : YYYY-MM-DD HH:MM).
o integer

L'ID de la commande liée à l'avis.
odate string

La date de la commande associée à l'avis (format : YYYY-MM-DD).
reply string

La réponse du vendeur à l'avis, si applicable.
rdate string

La date de la réponse du vendeur (format : YYYY-MM-DD), si applicable.
transl integer

Indique si l'avis a été traduit (1) ou non (0).
lang string

Le code de langue de l'avis (par exemple : 'fr' pour le français).

Exemple d'une réponse API pour une requête sur un produit :

JSON
{
  "ratings": {
    "total": 19,
    "average": "4.79",
    "distribution": {
      "1": "0",
      "2": "0",
      "3": "1",
      "4": "2",
      "5": "16"
    }
  },
  "reviews": [
    {
      "id": "2137030",
      "r": "5",
      "txt": "je recommande c'est un super produit très pratique d'utilisation",
      "date": "2022-02-24 12:10",
      "o": "28592",
      "odate": "2022-02-12",
      "reply": "",
      "rdate": "",
      "c": "Thierry B."
    },
    {
      "id": "2046418",
      "r": "5",
      "txt": "Impecable, je repasserais commande très rapidement",
      "date": "2022-02-11 09:35",
      "o": "23976",
      "odate": "2022-01-31",
      "reply": "Merci pour votre avis Pierre Lou !",
      "rdate": "2022-02-12",
      "c": "Pierre Lou B."
    },
    ...
  ]
}

Exemple 1 : Récupération des avis 'site'

Vous pouvez utiliser cette API avec divers langages de programmation et bibliothèques pour répondre aux besoins spécifiques de votre projet. Parmi les options populaires, on trouve PHP avec cURL ou file_get_contents, JavaScript pur ou jQuery.
Chaque langage a ses propres avantages et particularités, vous permettant de choisir la solution la mieux adaptée à votre contexte.

Les exemples de code fournis pour chaque langage et bibliothèque vous aideront à comprendre comment effectuer les requêtes pour interroger l'API, ainsi que comment exploiter les données retournées pour les intégrer dans votre application ou votre site web.
En suivant ces exemples, vous pourrez adapter les requêtes à vos besoins spécifiques et afficher les informations pertinentes pour vos utilisateurs.

<!DOCTYPE html> <html lang="fr"> <head> <meta charset="UTF-8"> <title>Exemple API avec JavaScript</title> </head> <body> <script> const public_key = 'your_public_key'; const scope = 'site'; // or Product ID (string or integer) const url = `https://api.guaranteed-reviews.com/public/v3/reviews/${public_key}/${scope}`; fetch(url) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error("Erreur :", error)); </script> </body> </html>

<!DOCTYPE html> <html lang="fr"> <head> <meta charset="UTF-8"> <title>Exemple API avec jQuery</title> <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script> </head> <body> <script> $(document).ready(function () { const public_key = 'your_public_key'; const scope = 'site'; // or Product ID (string or integer) const url = `https://api.guaranteed-reviews.com/public/v3/reviews/${public_key}/${scope}`; $.ajax({ url: url, dataType: 'json', success: function (data) { console.log(data); }, error: function (jqXHR, textStatus, errorThrown) { console.error("Erreur :", errorThrown); } }); }); </script> </body> </html>

<?php $public_key = 'your_public_key'; $scope = 'site'; // or Product ID (string or integer) $url = "https://api.guaranteed-reviews.com/public/v3/reviews/$public_key/$scope"; $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); if ($response === false) { echo "Erreur : " . curl_error($ch); } else { $data = json_decode($response, true); print_r($data); } curl_close($ch); ?>

<?php $public_key = 'your_public_key'; $scope = 'site'; // or Product ID (string or integer) $url = "https://api.guaranteed-reviews.com/public/v3/reviews/$public_key/$scope"; $response = file_get_contents($url); if ($response === false) { echo "Erreur : impossible de récupérer les données"; } else { $data = json_decode($response, true); print_r($data); } ?>

Exemple 2 : Récupération des avis 'produit'

Dans l'exemple ci-contre, vous disposez de 4 moyens différents de requêter l'API pour récupérer les avis d'un produit spécifique portant l'identifiant '42'.
Le Product ID attendu ici est celui que vous nous communiquez lors de l'envoi de vos commandes. Il s'agît donc d'un Product ID vous appartenant.

Dans le cas où vous auriez besoin d'aide supplémentaire, vous pouvez également contacter le support technique. Le support est disponible pour répondre à vos questions, vous fournir des conseils et vous assister dans la résolution des problèmes liés à l'utilisation de l'API. N'hésitez pas à les solliciter en cas de besoin.

<!DOCTYPE html> <html lang="fr"> <head> <meta charset="UTF-8"> <title>Exemple API avec JavaScript</title> </head> <body> <script> const public_key = 'your_public_key'; const scope = '42'; // Product ID (string or integer) const url = `https://api.guaranteed-reviews.com/public/v3/reviews/${public_key}/${scope}`; fetch(url) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error("Erreur :", error)); </script> </body> </html>

<!DOCTYPE html> <html lang="fr"> <head> <meta charset="UTF-8"> <title>Exemple API avec jQuery</title> <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script> </head> <body> <script> $(document).ready(function () { const public_key = 'your_public_key'; const scope = '42'; //Product ID (string or integer) const url = `https://api.guaranteed-reviews.com/public/v3/reviews/${public_key}/${scope}`; $.ajax({ url: url, dataType: 'json', success: function (data) { console.log(data); }, error: function (jqXHR, textStatus, errorThrown) { console.error("Erreur :", errorThrown); } }); }); </script> </body> </html>

<?php $public_key = 'your_public_key'; $scope = 42; //Product ID (string or integer) $url = "https://api.guaranteed-reviews.com/public/v3/reviews/$public_key/$scope"; $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); if ($response === false) { echo "Erreur : " . curl_error($ch); } else { $data = json_decode($response, true); print_r($data); } curl_close($ch); ?>

<?php $public_key = 'your_public_key'; $scope = 42; //Product ID (string or integer) $url = "https://api.guaranteed-reviews.com/public/v3/reviews/$public_key/$scope"; $response = file_get_contents($url); if ($response === false) { echo "Erreur : impossible de récupérer les données"; } else { $data = json_decode($response, true); print_r($data); } ?>