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 : unbegrenztDa diese API von CDN zwischengespeichert wird, kann sie direkt in Ajax von Ihrer Website aus aufgerufen werden.
-
Authentifizierung : neinDiese API verfügt nicht über eine Authentifizierung, da sie keine sensiblen Daten zurückgibt.
-
Anzahl der Ergebnisse : 1000 maxDie API gibt bis zu 1000 Meldungen pro Anfrage zurück, die nach Datum absteigend sortiert sind.
-
Durchschnittliche Reaktionszeit : 30 msDie ö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, obligatorischEinmaliger öffentlicher Schlüssel für den Zugriff auf die API
-
scope string, obligatorischArt der angeforderten Daten. 'Site' oder digitale Produkt-ID.
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 integerDie Gesamtzahl der Meinungen.
-
average floatDie vergebene Durchschnittsnote.
-
distribution arrayDie 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 integerDie eindeutige Kennung der Meldung.
-
c stringDer Vorname und der erste Buchstabe des Nachnamens der Klientin/des Klienten.
-
r integerDie Bewertung des Produkts (von 1 bis 5).
-
txt stringDer Text der vom Kunden hinterlassenen Bewertung.
-
date stringDas Datum, an dem die Bekanntmachung veröffentlicht wurde (Format: YYYY-MM-DD HH:MM).
-
o integerL'ID de la commande liée à l'avis.
-
odate stringDas Datum der mit der Meldung verbundenen Bestellung (Format: YYYY-MM-DD).
-
reply stringDie Antwort des Verkäufers auf den Hinweis, falls zutreffend.
-
rdate stringDas Datum der Antwort des Verkäufers (Format: YYYY-MM-DD), falls zutreffend.
-
transl integerZeigt an, ob die Meldung übersetzt wurde (1) oder nicht (0).
-
lang stringDer Sprachcode der Meldung (z. B.: 'fr' für Französisch).
Beispiel für eine API-Antwort auf eine Anfrage nach einem Produkt :
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.
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.