Public API – Reviews | Gesellschaft für Garantierte Bewertungen

Verwendung

Mit der öffentlichen API können Sie Anzeigen und Widgets direkt auf Ihrer Website generieren, ohne dass Sie die Bewertungen speichern müssen.
Im Gegensatz zur privaten API enthält sie keine persönlichen Informationen der Kunden (Name, E-Mail, Bestellnummer ...).

Nutzungsquoten : unbegrenzt

Da diese API von CDN zwischengespeichert wird, kann sie direkt in Ajax von Ihrer Website aus aufgerufen werden.
Authentifizierung : nein

Diese API verfügt nicht über eine Authentifizierung, da sie keine sensiblen Daten zurückgibt.
Anzahl der Ergebnisse : 1000 max

Die API gibt bis zu 1000 Meldungen pro Anfrage zurück, die nach Datum absteigend sortiert sind.
Durchschnittliche Reaktionszeit : 30 ms

Die öffentliche API ist so optimiert, dass sie Antwortzeiten hat, die eine flüssige Anzeige der Widgets ermöglichen.

Parameter der Abfrage

Die folgenden Einstellungen müssen verwendet werden, um die Abfrage anzupassen :

public_key string, obligatorisch

Einmaliger öffentlicher Schlüssel für den Zugriff auf die API
scope string, obligatorisch

Art der angeforderten Daten. 'Site' oder digitale Produkt-ID.

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

Beispiel für einen Anruf
https://api.guaranteed-reviews.com/public/v3/reviews/{YOUR_PUBLIC_KEY}/site

Valeurs retournées par l'API

Die API gibt eine Antwort zurück, die ein 'Ratings'-Objekt und ein 'Reviews'-Objekt enthält.

Ratings

Das Objekt 'ratings' liefert eine Zusammenfassung der Noten :

total integer

Die Gesamtzahl der Meinungen.
average float

Die vergebene Durchschnittsnote.
distribution array

Die Verteilung der Noten zwischen 1 und 5.

Reviews

Das Objekt 'reviews' ist eine Liste von Meinungen mit den folgenden Informationen für jede Meinung :

id integer

Die eindeutige Kennung der Meldung.
c string

Der Vorname und der erste Buchstabe des Nachnamens der Klientin/des Klienten.
r integer

Die Bewertung des Produkts (von 1 bis 5).
txt string

Der Text der vom Kunden hinterlassenen Bewertung.
date string

Das Datum, an dem die Bekanntmachung veröffentlicht wurde (Format: YYYY-MM-DD HH:MM).
o integer

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

Das Datum der mit der Meldung verbundenen Bestellung (Format: YYYY-MM-DD).
reply string

Die Antwort des Verkäufers auf den Hinweis, falls zutreffend.
rdate string

Das Datum der Antwort des Verkäufers (Format: YYYY-MM-DD), falls zutreffend.
transl integer

Zeigt an, ob die Meldung übersetzt wurde (1) oder nicht (0).
lang string

Der Sprachcode der Meldung (z. B.: 'fr' für Französisch).

Beispiel für eine API-Antwort auf eine Anfrage nach einem Produkt :

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

Beispiel 1: Abruf von 'site'-Meldungen

Sie können diese API mit verschiedenen Programmiersprachen und Bibliotheken verwenden, um den spezifischen Anforderungen Ihres Projekts gerecht zu werden. Zu den beliebten Optionen gehören PHP mit cURL oder file_get_contents, reines JavaScript oder jQuery.
Jede Sprache hat ihre eigenen Vorteile und Besonderheiten, sodass Sie die für Ihren Kontext am besten geeignete Lösung auswählen können.

Die für jede Sprache und Bibliothek bereitgestellten Codebeispiele helfen Ihnen zu verstehen, wie Sie Abfragen zur Abfrage der API durchführen und wie Sie die zurückgegebenen Daten auswerten und in Ihre Anwendung oder Website integrieren können.
Wenn Sie diese Beispiele befolgen, können Sie die Abfragen an Ihre speziellen Bedürfnisse anpassen und Ihren Nutzern die relevanten Informationen anzeigen.

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

Beispiel 2: Abrufen von 'Produkt'-Meinungen

Im nebenstehenden Beispiel haben Sie vier verschiedene Möglichkeiten, die API anzufordern, um Bewertungen für ein bestimmtes Produkt mit der Kennung '42' abzurufen.
Die hier erwartete Product ID ist diejenige, die Sie uns beim Absenden Ihrer Bestellungen mitteilen. Es handelt sich also um eine Product ID, die Ihnen gehört.

Für den Fall, dass Sie weitere Hilfe benötigen, können Sie sich auch an den technischen Support wenden. Der Support steht Ihnen zur Verfügung, um Ihre Fragen zu beantworten, Ihnen Ratschläge zu geben und Sie bei der Lösung von Problemen mit der Nutzung der API zu unterstützen. Zögern Sie nicht, sich bei Bedarf an sie zu wenden.

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