Documentación

Tres formas de enviar tus pedidos a Get5Stars: la integración de Shopify con un clic (recomendada para comerciantes de Shopify), la API REST (para cualquier otro back office) o la importación puntual de CSV desde tu panel.

• Shopify — instalación desde el panel y luego OAuth, sin necesidad de desarrollador. Ver Webhooks de Shopify.
• API REST — llama a POST /api/v1/orders/ingest en cada nuevo pedido. Ver API REST.
• Importación CSV — sube un CSV desde Mis clientes para enviar hasta 10 000 pedidos de una vez.

URL base: https://get5stars.app. Todas las llamadas se autentican mediante la cabecera x-api-key (tu clave aparece en Perfil → Clave API). Límite: 100 solicitudes / minuto / clave.

POST /api/v1/orders/ingest

Crea el pedido y programa el email inicial + los dos recordatorios según tu campaña. Idempotente en (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"
  }'

Respuestas

• 200 — { "order_id": "ORD-2031", "created": true }
• 200 — { "order_id": "ORD-2031", "created": false } (ya ingerido, idempotente)
• 400 — payload inválido (Zod). El cuerpo describe el campo erróneo.
• 401 — clave API ausente o cuenta suspendida.
• 402 — cuota mensual alcanzada (Starter 100 / Business 500). En Scale, el exceso se factura a +0,02 €.
• 429 — límite de tasa superado (100/min/clave).

Endpoints de reseñas

Los endpoints /api/v1/reviews/rate y /api/v1/reviews/submit alimentan el flujo de reseñas del lado del cliente. Normalmente no necesitas llamarlos manualmente: los usa la página pública de reseñas servida por Get5Stars.

Conectar y probar otra plataforma

Para una plataforma que no sea Shopify (WooCommerce, n8n, Zapier, código propio), envía tus pedidos a POST /api/v1/orders/ingest con tu clave API. Antes de elegir un plan, verifica la conexión: envía una solicitud de prueba a POST /api/v1/ping (cabecera x-api-key). En cuanto se recibe, tu plataforma queda marcada como conectada y puedes activar tu suscripción.

Tras la instalación OAuth desde tu panel, Get5Stars registra automáticamente dos webhooks de Shopify: orders/create (activa la secuencia de reseñas) y app/uninstalled (purga RGPD). No tienes que configurar nada manualmente.

• orders/create — cada nuevo pedido de Shopify se convierte en un pedido de Get5Stars. Firma HMAC verificada con tu SHOPIFY_API_SECRET.
• app/uninstalled — desinstalación limpia: cortamos los emails e iniciamos la purga de datos en un plazo de 30 días.
• shop/redact + customers/redact + customers/data_request — endpoints RGPD obligatorios de Shopify. Implementados y probados.

Resolución de problemas

• ¿Un pedido no llega? Comprueba Shopify Admin → Settings → Notifications → Webhooks. orders/create debe apuntar a https://get5stars.app/api/webhooks/shopify.
• ¿Recibes un 401? El secreto HMAC ha cambiado: reinstala la app desde tu panel para renovar el token.

Get5Stars utiliza un LLM de terceros (OpenRouter) para dos funciones opcionales: la extracción de temas en las reseñas negativas (plan Business y superiores) y la redacción de borradores de respuesta (plan Scale).

Datos enviados al LLM

• Temas: únicamente el texto de las reseñas ≤ 3★, en la ventana elegida (7 días, 30 días o todo el historial). Ningún email, nombre o identificador del cliente, ni nombre de la tienda. Las llamadas son incrementales: solo se envían las reseñas nuevas, y los temas ya calculados sirven de contexto.
• Respuestas IA: únicamente el texto de la reseña, su puntuación y el nombre del cliente (para el saludo). Nunca el nombre de tu tienda ni los datos de otras reseñas.

Proveedores

• OpenRouter (enrutador multimodelo, San Francisco, EE. UU.). Modelo principal: Llama 3.3 70B (Meta, gratuito, sin retención de datos). Alternativa: Gemini 2.5 Flash Lite (Google).
• Todas las llamadas son de servidor a servidor desde nuestros workers en la región CDG (Vercel).

Retención

• OpenRouter no conserva ningún prompt por defecto en los modelos « free » y « no-retention » que usamos.
• Los borradores de IA generados se almacenan en tu panel (campo aiReply) hasta que se elimina la reseña.

Desactivar

No se ejecuta ninguna extracción de temas hasta que abres la tarjeta « Temas » en el panel. Las respuestas IA se generan solo bajo demanda, con el botón « Respuesta IA » en el detalle de una reseña. Contacta con soporte para desactivar por completo los LLM en tu cuenta.