Skip to main content

How to get your API Key

An API Key is the only credential you need to integrate Neuroon. Use it to sync products, generate Widget Tokens, track conversions, and query analytics.

Steps​

1. Create your account​

Open the Neuroon 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 or Generic (custom). If your stack is anything other than WordPress + WooCommerce, pick Generic — the recipes cover Next.js, Nuxt, and any backend that speaks HTTP + JSON. If you pick Generic, you'll first need to verify your domain by adding a DNS TXT record — without it you won't be able to sync products and the widget won't work.

3. Copy your API Key​

After creating the shop, go to shop settings (Settings / Integrations). There you will find your API Key. Copy it and store it in your secret manager.

4. Save it as an environment variable​

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

NEUROON_API_URL=https://api.neuroon.ai
NEUROON_API_KEY=your_api_key_here

5. Verify it works​

curl https://api.neuroon.ai/api/integrations/v1/shop \
-H "Authorization: Bearer $NEUROON_API_KEY"

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

Production vs Development​

Each environment has its own API Key and they are independent. Use the navbar environment selector to see each environment's URLs:

EnvironmentDashboardAPI
ProductionProd Dashboardhttps://api.neuroon.ai
DevelopmentDev Dashboardhttps://dev-api.neuroon.ai

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