Public API – Reviews | Gegarandeerde Beoordelingen Nederland

Gebruik

Met de openbare API kunt u displays en widgets rechtstreeks op uw site genereren zonder dat u de berichten hoeft op te slaan.
In tegenstelling tot de private API bevat deze geen persoonlijke informatie van de klanten (naam, e-mail, bestelnummer...).

Contingenten voor gebruik : onbeperkt

Deze API wordt gecached door CDN en kan direct in ajax worden aangeroepen vanaf uw site.
Authenticatie : nee

Deze API heeft geen authenticatie omdat hij geen gevoelige gegevens retourneert.
Aantal resultaten : 1000 max.

De API stuurt tot 1000 berichten per verzoek terug, gesorteerd in aflopende datumvolgorde.
Gemiddelde reactietijd : 30 ms.

De openbare API is geoptimaliseerd voor reactietijden die een soepele weergave van widgets mogelijk maken.

Vraagparameters

De volgende parameters moeten worden gebruikt om de query aan te passen:

public_key string, verplicht

Unieke publieke sleutel voor toegang tot de API
scope string, verplicht

Soort gevraagde gegevens. site" of digitale product ID.

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

Voorbeeld van een oproep
https://api.guaranteed-reviews.com/public/v3/reviews/{YOUR_PUBLIC_KEY}/site

Valeurs retournées par l'API

De API stuurt een antwoord terug dat een "ratings" object en een "reviews" object bevat.

Ratings

Het object "beoordelingen" geeft een samenvatting van de beoordelingen:

total integer

Het totale aantal aankondigingen.
average float

De gemiddelde toegekende score.
distribution array

De verdeling van de scores tussen 1 en 5.

Reviews

Het "beoordelingen" object is een lijst van beoordelingen met de volgende informatie voor elke beoordeling:

id integer

De unieke identificatiecode van de aankondiging.
c string

De voornaam en de eerste letter van de naam van de cliënt.
r integer

De aan het product toegekende score (van 1 tot 5).
txt string

De tekst van de door de klant achtergelaten mededeling.
date string

De datum waarop de aankondiging werd gepubliceerd (formaat: JJJJ-MM-DD HH:MM).
o integer

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

De datum van de bestelling in verband met de aankondiging (formaat: JJJJ-MM-DD).
reply string

Het antwoord van de verkoper op de kennisgeving, indien van toepassing.
rdate string

De datum van het antwoord van de verkoper (formaat: JJJJ-MM-DD), indien van toepassing.
transl integer

Geeft aan of de mededeling is vertaald (1) of niet (0).
lang string

De taalcode van de aankondiging (bijvoorbeeld: "fr" voor Frans).

Voorbeeld van een API antwoord voor een productverzoek:

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."
    },
    ...
  ]
}

Voorbeeld 1: Ophalen van "site" aankondigingen

U kunt deze API gebruiken met verschillende programmeertalen en bibliotheken om te voldoen aan uw specifieke projectbehoeften. Populaire opties zijn PHP met cURL of file_get_contents, pure JavaScript of jQuery.
Elke taal heeft zijn eigen voordelen en bijzonderheden, zodat u de oplossing kunt kiezen die het best bij uw context past.

De codevoorbeelden voor elke taal en bibliotheek helpen u te begrijpen hoe u verzoeken kunt doen om de API te bevragen, en hoe u de geretourneerde gegevens kunt gebruiken om ze in uw toepassing of website te integreren.
Door deze voorbeelden te volgen, kunt u zoekopdrachten afstemmen op uw specifieke behoeften en de relevante informatie aan uw gebruikers tonen.

<!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); } ?>

Voorbeeld 2: Productbeoordelingen ophalen

In het voorbeeld hiernaast heb je 4 verschillende manieren om de API aan te vragen om beoordelingen van een specifiek product met de ID '42' op te halen.
De hier verwachte Product ID is de ID die u ons geeft bij het verzenden van uw bestellingen. Het is dus een product-ID van u.

Indien u verdere hulp nodig heeft, kunt u ook contact opnemen met de technische ondersteuning. Support is beschikbaar om uw vragen te beantwoorden, advies te geven en u te helpen bij het oplossen van problemen in verband met het gebruik van de API. Aarzel niet om hen te vragen als je hulp nodig hebt.

<!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); } ?>