Documentación

Trois façons d'envoyer vos commandes à Get5Stars : l'intégration Shopify en un clic (recommandée pour les marchands Shopify), l'API REST (pour tout autre back-office) ou l'import CSV ponctuel depuis votre dashboard.

• Shopify — installation depuis le dashboard puis OAuth, aucun développeur requis. Voir Webhooks Shopify.
• API REST — appelez POST /api/v1/orders/ingest à chaque nouvelle commande. Voir API REST.
• Import CSV — déposez un CSV depuis Mes clients pour pousser jusqu'à 10 000 commandes en une fois.

Base URL : https://get5stars.app. Tous les appels sont authentifiés via le header x-api-key (votre clé est visible dans Profil → Clé API). Limite : 100 requêtes / minute / clé.

POST /api/v1/orders/ingest

Crée la commande, planifie l'email initial + les deux relances selon votre campagne. Idempotent sur (merchantId, order_id).

curl -X POST https://get5stars.app/api/v1/orders/ingest \
  -H "x-api-key: $G5S_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "ORD-2031",
    "customer_email": "alice@example.com",
    "customer_first_name": "Alice",
    "customer_last_name": "Dupont",
    "order_date": "2026-05-28T10:21:00Z",
    "customer_locale": "fr-FR"
  }'

Réponses

• 200 — { "order_id": "ORD-2031", "created": true }
• 200 — { "order_id": "ORD-2031", "created": false } (déjà ingéré, idempotent)
• 400 — payload invalide (Zod). Le body décrit le champ fautif.
• 401 — clé API absente ou compte suspendu.
• 402 — quota mensuel atteint (Starter 100 / Business 500). Sur Scale, dépassement facturé +0,02 €.
• 429 — rate limit dépassé (100/min/clé).

Endpoints d'avis

Les endpoints /api/v1/reviews/rate et /api/v1/reviews/submit alimentent le flux d'avis côté client. Vous n'avez normalement pas à les appeler manuellement — ils sont utilisés par la page d'avis publique servie par Get5Stars.

Après installation OAuth depuis votre dashboard, Get5Stars enregistre automatiquement deux webhooks Shopify : orders/create (déclenche la séquence d'avis) et app/uninstalled (purge GDPR). Vous n'avez rien à configurer manuellement.

• orders/create — chaque nouvelle commande Shopify est convertie en ordre Get5Stars. Signature HMAC vérifiée avec votre SHOPIFY_API_SECRET.
• app/uninstalled — désinstallation propre : on coupe les emails et on lance la purge des données sous 30 jours.
• shop/redact + customers/redact + customers/data_request — endpoints obligatoires Shopify GDPR. Implémentés et testés.

Dépannage

• Une commande n'arrive pas ? Vérifiez Shopify Admin → Settings → Notifications → Webhooks. orders/create doit pointer sur https://get5stars.app/api/webhooks/shopify.
• Réponse 401 ? Le secret HMAC a changé — réinstallez l'app depuis votre dashboard pour rafraîchir le token.

Get5Stars utilise un LLM tiers (OpenRouter) pour deux fonctionnalités optionnelles : l'extraction de thèmes dans les avis négatifs (plan Business et plus) et la rédaction de brouillons de réponse (plan Scale).

Données envoyées au LLM

• Thèmes : uniquement le texte des avis ≤ 3★, sur la fenêtre choisie (7 jours, 30 jours ou tout l'historique). Aucun email, nom ou identifiant client, ni nom de boutique. Les appels sont incrémentaux : seuls les nouveaux avis sont envoyés, les thèmes déjà calculés servent de contexte.
• Réponses IA : uniquement le texte de l'avis, sa note, et le prénom du client (pour la formule d'appel). Jamais le nom de votre boutique, ni les données d'autres avis.

Fournisseurs

• OpenRouter (routeur multi-modèle, San Francisco, US). Modèle primaire : Llama 3.3 70B (Meta, gratuit, no data retention). Fallback : Gemini 2.5 Flash Lite (Google).
• Tous les appels sont serveur-à-serveur depuis nos workers en région CDG (Vercel).

Rétention

• OpenRouter ne conserve aucun prompt par défaut sur les modèles "free" et "no-retention" que nous utilisons.
• Les brouillons IA générés sont stockés dans votre dashboard (champ aiReply) jusqu'à suppression de l'avis.

Désactiver

Aucune extraction de thèmes n'est lancée tant que vous n'avez pas ouvert la carte « Thèmes » dans le dashboard. Les réponses IA sont générées uniquement à la demande, bouton « Réponse IA » dans le détail d'un avis. Contactez le support pour désactiver entièrement les LLM sur votre compte.