Skip to main content

How to get your Shop API Key

A Shop API Key (sk_…) is the only credential you need to integrate Neuroon. It's used to sync products, mint Widget Tokens, register conversions and query your quota.

Steps​

1. Create your account​

Open https://neuroon.ai/dashboard. First time? Click Get started / Sign up and follow the flow (Google OAuth or email).

2. Register your shop​

Once inside, Shops → Create shop. Fill in:

  • Name: anything you want (not public).
  • URL: the canonical domain of your shop (https://yourshop.com). Important: this domain is used to validate the widget. If you launch on both staging.yourshop.com and yourshop.com, contact support to add extra origins.
  • Platform: WooCommerce, Shopify, BigCommerce or Generic (custom). If your stack is not listed, pick Generic.

3. Copy your Shop API Key​

After creating the shop, the dashboard shows your Shop API Key (sk_<32 hex>). Copy it now, it's only shown once. If you lose it, regenerate (the old one is invalidated immediately).

sk_a1b2c3d4e5f6789012345678901234ab

4. Save it as an environment variable​

On your server (NEVER in the frontend or HTML):

# backend .env
NEUROON_API_KEY=sk_a1b2c3d4e5f6789012345678901234ab
NEUROON_SHOP_ID=shop_xxxxxxxxxxxxxxxxxxxxx

shop_id is shown next to the key in the dashboard.

5. Verify it works​

curl https://api.neuroon.ai/api/plugin/shops/me \
  -H "X-Shop-API-Key: $NEUROON_API_KEY"

Should return 200 with your shop info and quotas. If you get 401, check the key.

Production vs Development​

The dashboard has a Production / Development toggle. Each environment has its own API Key and they are independent:

EnvironmentDashboard URLAPI URL
Productionhttps://neuroon.ai/dashboardhttps://api.neuroon.ai
Developmenthttps://dev.neuroon.ai/dashboardhttps://dev-api.neuroon.ai

Keys follow the same format sk_<32hex> in both environments. shopId and key are different per environment, not interchangeable.

Always integrate against Development first. When everything works, switch the URLs and key to Production.

Best practices​

  • Rotate the key every 6–12 months or when a teammate leaves.
  • One key per environment (do not share between prod and dev).
  • Never commit the key to git. Use a .env ignored by .gitignore or a secret manager.
  • Never print it in public logs, error pages or HTTP responses.

Next steps​

You have the API Key. Now head to the Quickstart to sync your first product and embed the widget in 10 minutes.

Last updated on