API · Overview

As an integrator you call one single API: the Plugin API 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.

Plugin API

Prefix	Auth	Who uses it
/api/plugin/shops/*	X-Shop-API-Key + origin validation	Your server (any stack: Node, Python, Java, .NET, PHP, Ruby, Go)

It covers the three server-to-server flows: product sync, domain verification and 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 Shop 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 shape {timestamp, status, error, message, path}. Field-level errors aggregated to message with commas.
• Rate limits: per endpoint (not per plan). Full table at Rate limits.
• Indexing latency: 2-5 seconds after 200 OK on /plugin/shops/{shopId}/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 Shop API Key (X-Shop-API-Key) in the scheme field.
3. Fill the path/query/body parameters and press Send API Request. The response comes back with real headers and body.
4. Copy as cURL copies the equivalent command for your terminal.

Test keys

If you don't have credentials yet, contact support and we will issue a Shop API Key against Development with trial quotas.

Further reading

• API conventions — base URLs, headers, idempotency.
• Authentication · Overview — Shop API Key (server) vs Widget Token (HMAC signature for the browser).
• Quickstart — from zero to your first search in 5-10 minutes.