Utilice

La API pública le permite generar visualizaciones y widgets directamente en su sitio sin necesidad de almacenar las notificaciones.
A diferencia de la API privada, no contiene la información personal de los clientes (nombre, correo electrónico, número de pedido...).

  • Cuotas de utilización : ilimitado
    Almacenada en caché por CDN, esta API puede ser llamada directamente en ajax desde su sitio.
  • Autentificación : no
    Esta API no tiene autenticación porque no devuelve datos sensibles.
  • Número de resultados : 1000 máx.
    La API devuelve hasta 1000 notificaciones por solicitud, ordenadas por fecha descendente.
  • Tiempo medio de respuesta : 30 ms
    La API pública está optimizada para tener tiempos de respuesta que permitan una visualización fluida de los widgets.


Parámetros de consulta

Los siguientes parámetros deben utilizarse para personalizar la consulta:

  • public_key string, obligatorio
    Clave pública única para acceder a la API
  • scope string, obligatorio
    Tipo de datos solicitados. sitio" o ID de producto digital.
Endpoint
https://api.guaranteed-reviews.com/public/v3/reviews/{YOUR_PUBLIC_KEY}/{SCOPE}
Ejemplo de llamada
https://api.guaranteed-reviews.com/public/v3/reviews/{YOUR_PUBLIC_KEY}/site

Valeurs retournées par l'API

La API devuelve una respuesta que contiene un objeto "ratings" y un objeto "reviews".

Ratings

El objeto "calificaciones" proporciona un resumen de las calificaciones:

  • total integer
    El número total de notificaciones.
  • average float
    La puntuación media concedida.
  • distribution array
    La distribución de las puntuaciones entre 1 y 5.

Reviews

El objeto "reseñas" es una lista de reseñas con la siguiente información para cada una de ellas:

  • id integer
    El identificador único de la notificación.
  • c string
    El nombre y la primera letra del nombre del cliente.
  • r integer
    Puntuación otorgada al producto (de 1 a 5).
  • txt string
    El texto del aviso dejado por el cliente.
  • date string
    Fecha de publicación del anuncio (formato: AAAA-MM-DD HH:MM).
  • o integer
    L'ID de la commande liée à l'avis.
  • odate string
    Fecha de la orden asociada a la notificación (formato: AAAA-MM-DD).
  • reply string
    La respuesta del vendedor a la notificación, si procede.
  • rdate string
    La fecha de la respuesta del vendedor (formato: AAAA-MM-DD), si procede.
  • transl integer
    Indica si la notificación se ha traducido (1) o no (0).
  • lang string
    El código de la lengua del anuncio (por ejemplo: "fr" para el francés).

Ejemplo de respuesta API para una solicitud de producto:

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

Ejemplo 1: Recuperación de las notificaciones "de sitio

Puede utilizar esta API con varios lenguajes de programación y bibliotecas para satisfacer las necesidades específicas de su proyecto. Las opciones más populares incluyen PHP con cURL o file_get_contents, JavaScript puro o jQuery.
Cada lengua tiene sus propias ventajas y particularidades, lo que le permite elegir la solución que mejor se adapte a su contexto.

Los ejemplos de código proporcionados para cada lenguaje y biblioteca le ayudarán a comprender cómo realizar solicitudes para consultar la API, así como a utilizar los datos devueltos para integrarlos en su aplicación o sitio web.
Siguiendo estos ejemplos, podrá adaptar las consultas a sus necesidades específicas y mostrar la información pertinente a sus usuarios.

Ejemplo 2: Recuperación de reseñas de productos

En el ejemplo de la derecha, tiene 4 formas diferentes de solicitar a la API que recupere reseñas de un producto específico con el ID "42".
El ID de producto que se espera aquí es el que usted nos facilita al enviarnos sus pedidos. Se trata, por tanto, de un identificador de producto que le pertenece.

Si necesita más ayuda, también puede ponerse en contacto con el servicio de asistencia técnica. El servicio de asistencia técnica está a su disposición para responder a sus preguntas, asesorarle y ayudarle a resolver problemas relacionados con el uso de la API. No dudes en preguntarles si necesitas ayuda.