Publiczne API – Opinie | Gwarantowane Opinie Polska

Użycie

Publiczne API pozwala na generowanie wyświetleń i widgetów bezpośrednio na Twojej stronie bez konieczności przechowywania opinii.
W przeciwieństwie do prywatnego API, nie zawiera informacji osobistych klientów (imię, e-mail, numer zamówienia...).

Limity wykorzystania: nieograniczone

Cache'owanie przez CDN, to API może być wywoływane bezpośrednio w ajaxie z twojej strony.
Uwierzytelnienie : nie

To API nie wymaga uwierzytelnienia, ponieważ nie zwraca danych wrażliwych.
Liczba wyników : 1000 max

API zwraca do 1000 opinii na żądanie, posortowanych według daty malejąco.
Średni czas odpowiedzi: 30 ms

Publiczne API jest zoptymalizowane, aby zapewnić czasy odpowiedzi umożliwiające płynne wyświetlanie widgetów.

Parametry zapytania

Następujące parametry muszą być użyte do personalizacji zapytania:

public_key string, obowiązkowy

Unikalny klucz publiczny do uzyskania dostępu do API
scope string, obowiązkowy

Typ żądanych danych. 'site' lub ID produktu.

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

Przykład wywołania
https://api.guaranteed-reviews.com/public/v3/reviews/{YOUR_PUBLIC_KEY}/site

Wartości zwracane przez API

API zwraca odpowiedź zawierającą obiekt 'ratings' i obiekt 'reviews'.

Ratings

Obiekt 'ratings' dostarcza podsumowanie ocen:

total integer

Całkowita liczba opinii.
average float

Średnia przyznana ocena.
distribution array

Rozkład ocen między 1 a 5.

Reviews

Obiekt 'reviews' jest listą opinii z następującymi informacjami dla każdej opinii:

id integer

Unikalny identyfikator opinii.
c string

Imię i pierwsza litera nazwiska klienta.
r integer

Ocena przyznana produktowi (od 1 do 5).
txt string

Tekst opinii pozostawionej przez klienta.
date string

Data, w której opinia została opublikowana (format: RRRR-MM-DD GG:MM).
odate string

Data zamówienia związana z opinią (format: RRRR-MM-DD).
reply string

Odpowiedź sprzedawcy na opinię, jeśli dotyczy.
rdate string

Data odpowiedzi sprzedawcy (format: RRRR-MM-DD), jeśli dotyczy.
transl integer

Określa, czy opinia została przetłumaczona (1) czy nie (0).
lang string

Kod języka opinii (na przykład: 'fr' dla francuskiego).

Przykład odpowiedzi API dla zapytania o 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",
      "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",
      "odate": "2022-01-31",
      "reply": "Merci pour votre avis Pierre Lou !",
      "rdate": "2022-02-12",
      "c": "Pierre Lou B."
    },
    ...
  ]
}

Przykład 1: Pobieranie recenzji 'strona'

Możesz używać tego API z różnymi językami programowania i bibliotekami, aby zaspokoić specyficzne potrzeby swojego projektu. Wśród popularnych opcji znajdują się PHP z cURL lub file_get_contents, czysty JavaScript lub jQuery.
Każdy język ma swoje własne zalety i szczególności, co pozwala na wybór najlepiej dopasowanego rozwiązania do Twojego kontekstu.

Przykłady kodu dostarczone dla każdego języka i biblioteki pomogą Ci zrozumieć, jak wykonywać zapytania do API oraz jak wykorzystać zwrócone dane do integracji w Twojej aplikacji lub na stronie internetowej.
Podążając za tymi przykładami, będziesz mógł dostosować zapytania do swoich specyficznych potrzeb i wyświetlić istotne informacje dla swoich użytkowników.

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

Przykład 2: Pobieranie recenzji 'produkt'

W podanym przykładzie masz 4 różne sposoby na zażądanie API, aby uzyskać opinie na temat konkretnego produktu o identyfikatorze '42'.
Oczekiwany identyfikator produktu to ten, który nam przekazujesz podczas składania zamówień. Jest to więc identyfikator produktu, który do Ciebie należy.

W przypadku potrzeby dodatkowej pomocy możesz również skontaktować się z pomocą techniczną. Pomoc jest dostępna, aby odpowiedzieć na twoje pytania, udzielić porad i pomóc w rozwiązywaniu problemów związanych z korzystaniem z API. Nie wahaj się ich kontaktować w razie potrzeby.

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