France Avis
France Avis Étape 1 sur 2
France Avis Étape 2 sur 2
France Avis Déjà un compte ? Se connecter

Documentation de l’API

France Avis parle le langage de l’ancien prestataire : un logiciel déjà branché continue de marcher en changeant seulement l’adresse et les identifiants.

Gratuit, sans limite de volumeCompatible avec l’ancien prestataireOAuth2

Authentification

Créez un accès dans votre espace (Collecte, QR code, API) : un client_id et un secret, montré une seule fois. Échangez-les contre un jeton valable une heure :

curl -X POST https://france-avis.fr/oauth2/token -d grant_type=client_credentials -d client_id=fa_… -d client_secret=…

Puis appelez l’API avec le jeton dans l’en-tête Authorization :

curl https://france-avis.fr/api/v1/api-compat/published/brands/reviews?limit=50 -H "Authorization: Bearer …"

Points d’accès

Chaque point répond à son adresse France Avis et à l’adresse de l’ancien prestataire.

POST/oauth2/token
Le jeton d’accès (1 h, 24 000 appels par heure) Ancienne adresse : /realms/skeepers/protocol/openid-connect/token
GET/api/v1/api-compat/published/products
Vos produits et leur note Ancienne adresse : /verified-reviews/v1/published/products · portée apicompat.products:read
GET/api/v1/api-compat/published/products/ratings
Les notes de vos produits Ancienne adresse : /verified-reviews/v1/published/products/ratings · portée apicompat.productratings:read
GET/api/v1/api-compat/published/products/reviews
Les avis sur vos produits Ancienne adresse : /verified-reviews/v1/published/products/reviews · portée apicompat.productreviews:read
GET/api/v1/api-compat/published/brands/reviews
Les avis sur votre entreprise Ancienne adresse : /verified-reviews/v1/published/brands/reviews · portée apicompat.brandreviews:read
GET/api/v1/api-compat/published/brands
La note de votre entreprise (1 an, 5 ans, depuis le début) Ancienne adresse : /verified-reviews/v1/published/brands · portée apicompat.brands:read
POST/api/v1/api-compat/purchase-events/{website_id}/bulk-sync-insert
Vos commandes (50 par appel) : chacune devient une demande d’avis Ancienne adresse : /purchase-event/websites/{website_id}/purchase_events/bulk_sync_insert · portée apicompat.purchaseevents:create

Les listes se lisent par curseur : la page suivante est dans l’en-tête Link (rel="next"). Les moyennes sont des chaînes décimales (« 4.50 »).

Webhooks

Déclarez une adresse dans votre espace : France Avis y poste chaque avis publié (review.published) ou signalé (review.reported), au format Standard Webhooks. Vérifiez la signature ainsi :

HMAC-SHA256(base64_decode(secret), webhook-id + "." + webhook-timestamp + "." + corps) → webhook-signature: v1,<base64>

Les anciens modules e-commerce

Les modules WooCommerce, Magento 2, PrestaShop, Thelia, Sylius… de l’ancien prestataire marchent avec l’ID site et la clé secrète de votre espace. WooCommerce et Magento 2 sont appelés par France Avis chaque heure, une fois branchés dans votre espace.

  • POST/index.php?action=act_api_notification_sha1&type=json2La notification de commande (signée par la clé des modules)
  • GET/fr/cache/{c1}/{c2}/{c3}/{website_id}/AWS/…Les fichiers de notes et d’avis (infosite, all_products, reviews…)
  • GET/v1/websites/{website_id}/products/ratingsL’ancienne Product Reviews API
  • POST/productL’API Genesis (module Magento 2)
  • POST/index.php?action=act_api_product_reviews_helpfulLe vote « utile » des blocs d’avis

Vous venez de Trustpilot

Votre intégration Trustpilot marche avec France Avis : remplacez ses deux adresses de base par celle de France Avis. Les chemins, les champs et les jetons restent les mêmes.

Les deux adresses à remplacer
https://api.trustpilot.comhttps://france-avis.fr
https://invitations-api.trustpilot.comhttps://france-avis.fr

Prenez un jeton avec la clé et le secret d’un accès API de votre espace (Collecte, QR code, API) :

curl -X POST https://france-avis.fr/v1/oauth/oauth-business-users-for-applications/accesstoken -u "fa_…:secret" -d grant_type=client_credentials

Les routes publiques se lisent avec la clé publique, l’identifiant de l’accès (fa_…), dans l’en-tête apikey. Votre businessUnitId est l’identifiant de votre entreprise : find?name=votre-domaine le donne.

curl "https://france-avis.fr/v1/business-units/find?name=votre-domaine.fr" -H "apikey: fa_…"
AuthentificationAvec la clé et le secret d’un accès API de votre espace.
POST/v1/oauth/oauth-business-users-for-applications/accesstoken
Le jeton : client_credentials, password (un membre de votre équipe) ou refresh_token ; 100 h
POST/v1/oauth/oauth-business-users-for-applications/refresh
Rafraîchir le jeton d’un membre (30 jours)
POST/v1/oauth/oauth-business-users-for-applications/revoke
Révoquer un jeton
InvitationsJeton Bearer. Une invitation devient une commande, avec ses demandes d’avis marque et produit.
POST/v1/private/business-units/{businessUnitId}/email-invitations
Une invitation par e-mail (serviceReviewInvitation, productReviewInvitation) portée trustpilotcompat.invitationsemail:create
POST/v1/private/business-units/{businessUnitId}/invitation-links
Un lien d’avis à envoyer vous-même portée trustpilotcompat.invitationslink:create
POST/v1/private/product-reviews/business-units/{businessUnitId}/invitation-links
Un lien d’avis produit portée trustpilotcompat.invitationsproductlink:create
GET/v1/private/business-units/{businessUnitId}/templates
Vos modèles de demande portée trustpilotcompat.invitationstemplates:read
POST/v1/private/business-units/{businessUnitId}/invitation-data/delete
Effacer les données d’invitation (RGPD) portée trustpilotcompat.invitationsdelete:delete
Votre entreprise et ses avisClé publique apikey (l’identifiant de l’accès), lecture seule.
GET/v1/business-units/find?name={domaine}
Votre businessUnitId, à partir de votre domaine
GET/v1/business-units/{businessUnitId}
La note (trustScore, stars) et le nombre d’avis par étoile
GET/v1/business-units/{businessUnitId}/reviews
Vos avis publiés : filtres stars, language, responded, tri orderBy, page et perPage
GET/v1/business-units/{businessUnitId}/all-reviews
Tous vos avis, page par page (pageToken)
GET/v1/business-units/{businessUnitId}/web-links
L’adresse de votre page et du dépôt d’avis
GET/v1/reviews/{reviewId} · /v1/reviews/latest
Un avis, ou les derniers avis
Avis produitsClé publique apikey ; les routes /private/ avec le jeton Bearer.
GET/v1/product-reviews/business-units/{businessUnitId}/reviews?sku={sku}
Les avis d’un ou plusieurs produits
GET/v1/product-reviews/business-units/{businessUnitId}?sku={sku}
La note d’un produit (starsAverage, numberOfReviews)
POST/v1/product-reviews/business-units/{businessUnitId}/batch-summaries
Les notes de plusieurs produits en un appel
GET/v1/private/product-reviews/business-units/{businessUnitId}/summaries
Les notes de tous vos produits portée trustpilotcompat.productreviewsprivatesummaries:read
GET/v1/private/product-reviews/business-units/{businessUnitId}/reviews
Vos avis produits avec la commande et le client portée trustpilotcompat.productreviewsprivatereviews:read
GET/v1/private/product-reviews/{reviewId}
Un avis produit portée trustpilotcompat.productreviewsprivatereview:read
Avis privés et réponsesJeton Bearer. Une réponse passe par la modération avant d’être publiée, comme depuis votre espace.
GET/v1/private/business-units/{businessUnitId}/reviews
Vos avis avec la commande (referenceId) et l’e-mail du client portée trustpilotcompat.privatereviewslist:read
GET/v1/private/reviews/{reviewId}
Un avis portée trustpilotcompat.privatereviewsshow:read
POST/v1/private/reviews/{reviewId}/reply
Répondre (relu par la modération avant publication) portée trustpilotcompat.privatereviewsreply:create
DELETE/v1/private/reviews/{reviewId}/reply
Retirer votre réponse portée trustpilotcompat.privatereviewsdeletereply:delete

Ce qui diffère

  • Une réponse envoyée par l’API est relue par la modération avant d’être publiée, comme toute réponse sur France Avis.
  • Les codes HTTP sont ceux de Trustpilot ; le corps d’une erreur peut différer du leur.

Ce qui n’est pas pris en charge

  • Les widgets TrustBox (un script servi par Trustpilot) : posez nos widgets à la place, rubrique Collecte.
  • Le catalogue produits privé : vos produits arrivent avec vos invitations et vos commandes.
  • Les catégories, les conversations et la connexion authorization_code.

Limites

200 éléments au plus par page, 50 commandes par appel, cinq accès API et cinq modules par entreprise. Les avis renvoyés sont les avis publiés ; l’adresse e-mail d’un client n’est renvoyée que par les routes privées compatibles Trustpilot, à votre seul jeton.