Getting started

Environments

Demo is where you build and test. Your user and company data, the marketplaces you create and your API keys stay on Demo permanently — they are not reset. The try-it console on this site sends requests to Demo only. Enter only a Demo key there (this browser keeps it in local storage); never a production key, and never put a key in code that runs in a browser or app.

Setup checklist

1. 1

   Sign up and log in to Demo

   Create your account on lead.zolar.com. Then log in to demo.lead.zolar.tech with the same account. A new organisation starts on the Welcome screen.

2. 2

   Become a lead provider

   Required first

   Only lead providers can create marketplaces and send leads. Without it, the API answers 403 CAPABILITY_REQUIRED.

   In the portal: Welcome → Become a lead provider, or My Marketplaces → Create Marketplace once your organisation is onboarded

   • Demo: choose Request to be a lead provider. It is approved automatically and you land in My Marketplaces.
   • Production: the same request lets zolar's team know; they contact you and mark your organisation as a lead provider (see Going live).
3. 3

   Create a marketplace

   Required first

   The marketplace is where your leads are offered to installers.

   In the portal: My Marketplaces → Create Marketplace

   You choose a name, a type (Public, Private or Per Request), whether it is Active or Inactive, and at least one region (DE, NL, BE). On Demo, choose Public.

   New marketplaces start as Draft. On Demo, Draft is fine: test right away. On production, use Request approval. Installers see a marketplace and its leads, and you can invite installers, only once it is approved and Active; a rejected one can be edited and resubmitted.

4. 4

   Create a lead source

   Required first

   A lead source names where your leads come from. Every lead you send is attributed to a lead source and priced against it. Each lead source feeds exactly one marketplace.

   In the portal: My Marketplaces → Lead Sources

   Give it a name and pick the marketplace it feeds. The name is only for your reference and must be unique within the marketplace.

   Moving a lead source to another marketplace moves its leads and their revenue too. It can't be deleted while it has its own pricing, a bound API key or leads.

5. 5

   Create an API key

   In the portal: Settings → API Keys

   • Pick Insert leads (api:provider:lead:write) and choose the lead source from step 4. Every lead you create with this key lands in that lead source; for several lead sources, create one key each.
   • Add Read leads (api:provider:lead:read — list and fetch leads, list your marketplaces) and Update leads (api:provider:lead:update) if you need them. They need no lead source and work across all marketplaces you own.

   The full key (sk_…) is shown once — copy it straight away. If you lose it, create a new key.

   To rotate a key: create a new one with the same permissions and lead source, switch your system to it, then delete the old one — its lead source and leads stay.

6. 6

   Check it with GET /api/public/v2/account

   Call Check your API key. The response shows the key name, its permissions, your organisation, the lead source and marketplace it feeds, and the environment.

   curl Copy

   curl https://demo.api.lead.zolar.tech/api/public/v2/account \
     -H "Authorization: Bearer sk_[YOUR DEMO KEY]"