Skip to main content

Quickstart

This guide takes you from zero to the widget rendered on your shop in 10 minutes. No theory, no internals. Copy-paste and done.

Before you start​

You need one thing: your Shop API Key (sk_…). If you don't have it yet, go to How to get your Shop API Key (3 minutes) and come back.

export NEUROON_API_KEY=sk_your_key_here
export NEUROON_SHOP_ID=shop_your_id_here

1. Sync your first product​

From your server:

curl -X POST https://api.neuroon.ai/api/plugin/shops/$NEUROON_SHOP_ID/products/sync \
  -H "X-Shop-API-Key: $NEUROON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "syncType": "INCREMENTAL",
    "products": [{
      "externalId": "demo-001",
      "name": "Basic black t-shirt",
      "price": 19.99,
      "currency": "EUR",
      "url": "https://yourshop.com/p/demo-001"
    }]
  }'

Response (200):

{ "totalReceived": 1, "newProducts": 1, "updatedProducts": 0, "failed": 0 }

The product is searchable in 2 to 5 seconds. Repeat the POST with your catalog in batches of up to 500 products.

2. Generate a Widget Token​

From your server:

curl -X POST https://api.neuroon.ai/api/shops/$NEUROON_SHOP_ID/widget-token \
  -H "X-Shop-API-Key: $NEUROON_API_KEY"

Response (200):

{ "token": "c2hvcF9hYmM6MTcxNTAwMDAwMDoxYTJiM2M..." }

Cache this token on your server for 24 hours. After that, call the endpoint again.

3. Embed the widget on your shop​

In your shop's HTML template (any framework: Next.js, Razor, PHP, Express, Rails…):

<div id="neuroon-search"></div>
<script
  src="https://cdn.neuroon.ai/widget.js"
  data-token="THE_TOKEN_FROM_STEP_2"
  data-container="#neuroon-search"
  data-theme="auto"
  data-locale="en">
</script>

Replace THE_TOKEN_FROM_STEP_2 with your template engine's syntax.

4. Test​

Open your shop. The widget mounts inside the #neuroon-search container. Type "shirt" in the search box and your products appear.

If something doesn't work, go to Troubleshooting.

Next steps​

Last updated on