Getting started

Onboarding checklist

Follow these steps from application through your first live order.

1. 1

   Submit a valid business profile

   Run nerionx start for full-screen Bubble Tea CLI onboarding or use the web flow. A CLI application requires validated contact, company, address, website, region, language, and currency details and cannot bypass Hub validation or operator review.

2. 2

   Receive API credentials

   After approval you get dashboard access and a brand_id. The setup guide lets you generate the first API key and shows its plaintext once; rotate keys from the dashboard when needed.

3. 3

   Install and configure the CLI

   Install the public native Go CLI from install.nerionx.dev. It is the only supported distribution and owns onboarding, Brand Kit operations, fleet control, and the governed Docker agent. Local config and profiles use owner-only storage.

4. 4

   Provision your Brand Kit

   Confirm docker compose version succeeds, then run nerionx init and nerionx up to create the containerized Spoke database, apply migrations, start the Spoke and storefront, and wait until the public storefront page is renderable.

5. 5

   Sync catalog and integrate checkout

   Page through GET /products/sync, mirror locally, then route checkout through your Spoke backend which forwards to Hub POST /orders.

Apply for access

New pharmacies start with a public application — no API key required.

Your first API call

After approval, list your catalog with a sandbox or live key.

curl -s "https://api.staging.nerionx.dev/api/v1/products?limit=20&offset=0" \
  -H "X-API-Key: nx_live_your_key"

Next steps

• Hub API reference →
• Brand Kit API →
• CLI onboarding & operations →