Public API – Reviews | Società Recensioni Garantite

Utilizzo

L'API pubblica consente di generare visualizzazioni e widget direttamente sul proprio sito senza memorizzare gli avvisi.
A differenza dell'API privata, non contiene le informazioni personali dei clienti (nome, e-mail, numero d'ordine...).

Quote di utilizzo : illimitato

Custodita nella cache da CDN, questa API può essere richiamata direttamente in ajax dal vostro sito.
Autenticazione : no

Questa API non prevede l'autenticazione perché non restituisce dati sensibili.
Numero di risultati : 1000 max

L'API restituisce fino a 1000 avvisi per richiesta, ordinati in ordine decrescente di data.
Tempo medio di risposta : 30 ms

L'API pubblica è ottimizzata per avere tempi di risposta che consentano una visualizzazione fluida dei widget.

Parametri della query

Per personalizzare la query è necessario utilizzare i seguenti parametri:

public_key string, obbligatorio

Chiave pubblica unica per accedere all'API
scope string, obbligatorio

Tipo di dati richiesti. sito" o l'ID del prodotto digitale.

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

Esempio di chiamata
https://api.guaranteed-reviews.com/public/v3/reviews/{YOUR_PUBLIC_KEY}/site

Valeurs retournées par l'API

L'API restituisce una risposta contenente un oggetto "ratings" e un oggetto "reviews".

Ratings

L'oggetto "ratings" fornisce un riepilogo delle valutazioni:

total integer

Il numero totale di avvisi.
average float

Il punteggio medio assegnato.
distribution array

La distribuzione dei punteggi tra 1 e 5.

Reviews

L'oggetto "recensioni" è un elenco di recensioni con le seguenti informazioni per ogni recensione:

id integer

L'identificatore unico dell'avviso.
c string

Il nome e la prima lettera del nome del cliente.
r integer

Il punteggio assegnato al prodotto (da 1 a 5).
txt string

Il testo dell'avviso lasciato dal cliente.
date string

La data di pubblicazione dell'avviso (formato: AAAA-MM-GG HH:MM).
odate string

La data dell'ordine associato all'avviso (formato: AAAA-MM-GG).
reply string

La risposta del venditore all'avviso, se applicabile.
rdate string

La data della risposta del venditore (formato: AAAA-MM-GG), se applicabile.
transl integer

Indica se l'avviso è stato tradotto (1) o meno (0).
lang string

Il codice della lingua dell'avviso (ad esempio: "fr" per il francese).

Esempio di risposta API per una richiesta di prodotto:

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

Esempio 1: Recupero degli avvisi "sito

È possibile utilizzare questa API con diversi linguaggi di programmazione e librerie per soddisfare le esigenze specifiche del progetto. Le opzioni più diffuse sono PHP con cURL o file_get_contents, JavaScript puro o jQuery.
Ogni lingua ha i suoi vantaggi e le sue particolarità, permettendovi di scegliere la soluzione più adatta al vostro contesto.

Gli esempi di codice forniti per ciascun linguaggio e libreria vi aiuteranno a capire come effettuare le richieste per interrogare l'API e come utilizzare i dati restituiti per integrarli nella vostra applicazione o sito web.
Seguendo questi esempi, sarete in grado di adattare le query alle vostre esigenze specifiche e di visualizzare le informazioni pertinenti ai vostri utenti.

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

Esempio 2: Recupero delle recensioni dei prodotti

Nell'esempio a destra, sono disponibili 4 modi diversi di richiedere l'API per recuperare le recensioni di un prodotto specifico con l'ID '42'.
L'ID prodotto previsto è quello che ci avete fornito al momento dell'invio degli ordini. Si tratta quindi di un ID prodotto che vi appartiene.

Se avete bisogno di ulteriore aiuto, potete anche contattare il supporto tecnico. L'assistenza è disponibile per rispondere alle vostre domande, fornire consigli e assistervi nella risoluzione di problemi legati all'uso dell'API. Non esitate a chiedere loro se avete bisogno di aiuto.

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