Saltar al contenido principal

API · Visión general

Como integrador llamas una sola API: la Plugin API desde tu servidor. Toda la referencia de este sitio se genera directamente desde la spec OpenAPI 3.1 que el backend publica en cada release. Si algo aparece aquí, existe en producción; si no aparece, no existe.

Plugin API​

PrefijoAuthQuién lo usa
/api/plugin/shops/*X-Shop-API-Key + validación de origenTu servidor (cualquier stack: Node, Python, Java, .NET, PHP, Ruby, Go)

Cubre los tres flujos server-to-server: sync de productos, verificación de dominio y tracking de conversiones. El playground "Try It" está en Reference (Try it) (columna izquierda).

El widget embebido en el navegador habla con su propio backend interno. Tú no llamas a esos endpoints — el bundle del widget (cdn.neuroon.ai/widget.js) los consume directamente con un Widget Token que firma tu propio servidor localmente con la Shop API Key (HMAC). Ver Authentication · Widget Token.

Convenciones globales​

  • Formato: JSON UTF-8. Content-Type: application/json.
  • Idiomas: el backend acepta Accept-Language y devuelve textos generados en uno de los 9 idiomas soportados si encaja; cae a es por defecto.
  • Errores: estructura uniforme {timestamp, status, error, message, path}. Campos field-level agregados al message con coma.
  • Rate limits: por endpoint (no por plan). Tabla completa en Rate limits.
  • Latencia de indexación: 2-5 segundos tras 200 OK en /plugin/shops/{shopId}/products/sync (eventual consistency).

Los detalles operativos (URLs base por entorno, headers obligatorios, idempotencia) están en Convenciones de la API.

Cómo usar el playground​

Las páginas de Reference embeben un explorador interactivo. Para probar:

  1. Selecciona el entorno (Production o Development) con el selector del navbar.
  2. Pega tu Shop API Key (X-Shop-API-Key) en el campo del esquema.
  3. Rellena los path/query/body parameters y pulsa Send API Request. La respuesta llega con headers y body reales.
  4. Copy as cURL copia el comando equivalente para tu terminal.

Próximas lecturas​

Última actualización en