API pública – Avaliações | Sociedade de Avaliações Garantidas

Utilização

A API pública permite gerar exibições e widgets diretamente no seu site sem que você armazene as avaliações.
Ao contrário da API privada, não contém informações pessoais dos clientes (nome, email, número de encomenda...).

Quotas de utilização: ilimitados

Cache por CDN, esta API pode ser chamada diretamente em ajax a partir do seu site.
Autenticação : não

Esta API não possui autenticação porque não retorna dados sensíveis.
Número de resultados: 1000 max

A API retorna até 1000 avaliações por requisição, ordenadas por data decrescente.
Tempo médio de resposta: 30 ms

A API pública é otimizada para ter tempos de resposta que permitem uma exibição fluida dos widgets.

Parâmetros da solicitação

Os seguintes parâmetros devem ser utilizados para personalizar a requisição:

public_key string, obrigatório

Chave pública única para aceder à API
scope string, obrigatório

Tipo de dados solicitados. 'site' ou ID do produto.

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

Exemplo de chamada
https://api.guaranteed-reviews.com/public/v3/reviews/{YOUR_PUBLIC_KEY}/site

Valores retornados pela API

A API retorna uma resposta contendo um objeto 'ratings' e um objeto 'reviews'.

Ratings

O objeto 'ratings' fornece um resumo das notas:

total integer

O número total de avaliações.
average float

A nota média atribuída.
distribution array

A repartição das notas entre 1 e 5.

Reviews

O objeto 'reviews' é uma lista de avaliações com as seguintes informações para cada avaliação:

id integer

O identificador único da avaliação.
c string

O primeiro nome e a primeira letra do sobrenome do cliente.
r integer

A nota atribuída ao produto (de 1 a 5).
txt string

O texto da avaliação deixada pelo cliente.
date string

A data em que a avaliação foi publicada (formato: AAAA-MM-DD HH:MM).
odate string

A data do pedido associada à avaliação (formato: AAAA-MM-DD).
reply string

A resposta do vendedor à avaliação, se aplicável.
rdate string

A data da resposta do vendedor (formato: AAAA-MM-DD), se aplicável.
transl integer

Indica se o aviso foi traduzido (1) ou não (0).
lang string

O código de língua da avaliação (por exemplo: 'fr' para francês).

Exemplo de uma resposta API para uma consulta sobre um produto:

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

Exemplo 1: Recuperação das avaliações 'site'

Você pode usar esta API com várias linguagens de programação e bibliotecas para atender às necessidades específicas do seu projeto. Entre as opções populares, estão PHP com cURL ou file_get_contents, JavaScript puro ou jQuery.
Cada linguagem tem suas próprias vantagens e particularidades, permitindo que você escolha a solução mais adequada ao seu contexto.

Os exemplos de código fornecidos para cada linguagem e biblioteca ajudarão você a entender como realizar as requisições para interrogar a API, assim como a como explorar os dados retornados para integrá-los na sua aplicação ou no seu site web.
Seguindo estes exemplos, poderá adaptar as solicitações às suas necessidades específicas e exibir as informações relevantes para os seus utilizadores.

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

Exemplo 2: Recuperação das avaliações 'produto'

No exemplo ao lado, você tem 4 maneiras diferentes de solicitar a API para recuperar as avaliações de um produto específico com o identificador '42'.
O ID do produto esperado aqui é aquele que nos comunica ao enviar os seus pedidos. Trata-se, portanto, de um ID de produto que lhe pertence.

Caso precise de ajuda adicional, você também pode entrar em contato com o suporte técnico. O suporte está disponível para responder às suas perguntas, fornecer conselhos e ajudá-lo na resolução de problemas relacionados ao uso da API. Não hesite em contatá-los se necessário.

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