Skip to main content

API · Overview

As an integrator you call one single API: the External Integrations API (/api/integrations/v1/*) from your server. The reference on this site is generated directly from the OpenAPI 3.1 spec the backend publishes on every release. If something appears here, it exists in production; if it doesn't appear, it doesn't exist.

External Integrations API​

PrefixAuthWho uses it
/api/integrations/v1/*Authorization: Bearer <api-key>Your server (any stack: Node, Python, Java, .NET, PHP, Ruby, Go)

Covers all server-to-server flows: catalog lookup and sync, conversion tracking. The "Try It" playground lives under Reference (Try it) (left column).

The widget embedded in the browser talks to its own internal backend. You don't call those endpoints — the widget bundle (cdn.neuroon.ai/widget.js) consumes them directly using a Widget Token that your own server signs locally with the API Key (HMAC). See Authentication · Widget Token.

Global conventions​

  • Format: JSON UTF-8. Content-Type: application/json.
  • Languages: the backend accepts Accept-Language and returns generated text in one of the 9 supported locales when it fits; falls back to es by default.
  • Errors: uniform structure. See Reference · Errors.
  • Rate limits: based on your subscription plan. X-RateLimit-* headers in every response.
  • Indexing latency: 2-5 seconds after 200 OK on /products/sync (eventual consistency).

Operational details (base URLs per environment, mandatory headers, idempotency) live at API conventions.

How to use the playground​

The Reference pages embed an interactive explorer. To try it:

  1. Select the environment (Production or Development) with the navbar selector.
  2. Paste your API Key in the authentication field (Bearer).
  3. Fill the path/query/body parameters and press Send API Request. The response comes back with real headers and body.

Further reading​

Last updated on