Documentation API Avis | Société des Avis Garantis

Vous trouverez ci-dessous notre documentation de notre API vous permettant de récupérer vos avis clients.

Paramètres de la requête

Les paramètres suivants peuvent être utilisés pour personnaliser la requête :

api_key string, obligatoire

La clé API unique pour accéder à l'API.
review_type string, optionnel

Le type d'avis à récupérer (site, product ou both).
product_id int, optionnel

L'identifiant du produit pour lequel récupérer les avis.
page int, optionnel

La page des résultats à récupérer (pagination).
order string, optionnel

L'identifiant de la commande pour laquelle récupérer les avis.
status int, optionnel

Le statut des avis à récupérer (par exemple, approuvé, en attente, etc.).
email string, optionnel

L'adresse e-mail du client pour lequel récupérer les avis.
date_from date, optionnel

La date de début pour récupérer les avis (au format YYYY-MM-DD).
date_to date, optionnel

La date de fin pour récupérer les avis (au format YYYY-MM-DD).
update_from date, optionnel

La date de début pour récupérer les avis en fonction de leur dernière mise à jour (au format YYYY-MM-DD).
update_to date, optionnel

La date de fin pour récupérer les avis en fonction de leur dernière mise à jour (au format YYYY-MM-DD).

L'API est accessible via l'URL suivante :

Endpoint
https://www.societe-des-avis-garantis.fr/wp-json/api/v3/reviews

Valeurs retournées par l'API

L'API retourne une liste d'avis avec les informations suivantes pour chaque avis :

id

L'identifiant unique de l'avis.
review_site_id

L'identifiant du site associé à l'avis.
reviewer_name

Le nom du client qui a laissé l'avis.
reviewer_email

L'adresse e-mail du client qui a laissé l'avis.
review_text

Le texte de l'avis.
review_rating

La note attribuée par le client (généralement de 1 à 5).
review_status

Le statut de l'avis (par exemple, approuvé, en attente, etc.).
date_time

La date et l'heure auxquelles l'avis a été soumis.
last_state_update

La date et l'heure de la dernière mise à jour du statut de l'avis.

Exemple d'une liste d'avis qui peut être retournée :

JSON
[
                    {
                    "id": "1385467",
                    "review_site_id": "4933",
                    "reviewer_name": "Jeanne",
                    "reviewer_email": "jeanne@example.com",
                    "review_text": "Super site !",
                    "review_rating": 5,
                    "review_status": 1,
                    "date_time": "2023-01-01 13:12:55",
                    "last_state_update": "2023-01-04 15:41:03",
                    }
                    ]

Exemple d'utilisation de l'API

Dans cet exemple, tous les paramètres facultatifs sont utilisés pour filtrer les avis récupérés. Vous devez remplacer "YOUR_API_KEY" par votre clé API réelle. Les autres paramètres peuvent être modifiés en fonction de vos besoins.

Cette fonction utilise la méthode POST pour envoyer les données à l'URL de l'API, avec les options de configuration correspondantes pour l'en-tête et le contenu de la requête. Elle retourne les avis sous forme de tableau au format JSON.

Le code d'exemple initialise les valeurs des paramètres nécessaires à l'appel de la fonction, puis appelle la fonction avec ces paramètres pour récupérer les avis. Si les avis sont récupérés avec succès, le résultat sera au format JSON. Si une erreur survient lors de la récupération des avis, un message d'erreur est affiché.

PHP
Javascript

<?php function fetch_reviews($api_key, $review_type, $product_id, $page, $order, $status, $email, $date_from, $date_to, $update_from, $update_to) { $url = "https://www.societe-des-avis-garantis.fr/wp-json/api/v3/reviews"; // Préparez les données de la requête POST $data = array( 'api_key' => $api_key, 'review_type' => $review_type, 'product_id' => $product_id, 'page' => $page, 'order' => $order, 'status' => $status, 'email' => $email, 'date_from' => $date_from, 'date_to' => $date_to, 'update_from' => $update_from, 'update_to' => $update_to ); // Configurez la requête POST avec les données $options = array( 'http' => array( 'header' => "Content-type: application/x-www-form-urlencoded\r\n", 'method' => 'POST', 'content' => http_build_query($data) ) ); $context = stream_context_create($options); $result = file_get_contents($url, false, $context); if ($result === FALSE) { return null; } return json_decode($result, true); } $api_key = "YOUR_API_KEY"; $review_type = "both"; $product_id = null; $page = 1; $order = "ORDER_ID"; $status = 1; $email = "john.doe@example.com"; $date_from = "2023-01-01"; $date_to = "2023-01-31"; $update_from = "2023-01-01"; $update_to = "2023-01-31"; $reviews = fetch_reviews($api_key, $review_type, $product_id, $page, $order, $status, $email, $date_from, $date_to, $update_from, $update_to); if ($reviews !== null) { print_r($reviews); } else { echo "Erreur lors de la récupération des avis"; } ?>

async function fetchReviews(email) { const apiKey = "YOUR_API_KEY"; // Remplacez "YOUR_API_KEY" par votre clé API const url = `https://www.societe-des-avis-garantis.fr/wp-json/api/v3/reviews`; const data = { api_key: apiKey, review_type: "both", page: 1, email: email }; try { const response = await fetch(url, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify(data) }); if (response.ok) { const reviews = await response.json(); console.log(reviews); } else { console.error("Erreur lors de la récupération des avis"); } } catch (error) { console.error("Erreur lors de la récupération des avis", error); } } fetchReviews("john.doe@example.com");

Intégration sur votre site web

Pour intégrer les avis récupérés sur votre site web, vous pouvez utiliser des éléments HTML et CSS pour afficher les informations.

Notre support technique est disponible à l'adresse : contact@societe-des-avis-garantis.fr si vous avez une question concernant l'implémentation de notre API.