Skip to main content

Get Started

This guide walks you through setting up iCCandle for your platform from the very beginning. Follow the five steps in order — each step builds on the one before it.

By the end you will have:

  • An account on the Uptech manager (the platform admin dashboard)
  • One API key that every broker on your platform shares
  • Each broker connected with its own identifier
  • End users signed in under the correct broker, and a web interface each broker can use to manage those users
info

Two terms you will see throughout

  • API key — a secret string that proves requests come from your platform. You create it once and reuse it for every broker.

  • Identifier — a unique ID or name you choose for each broker (for example A broker). It tells iCCandle which broker a user or management page belongs to under your shared API key. Every broker must have a different identifier (minimum 4 characters, maximum 32).

    You do not create identifiers in the admin dashboard by hand. iCCandle creates the broker on your platform the first time that identifier is used with your API key, in either of these ways:

    1. Seamless auth — your backend sends identifier in the login request body.
    2. Management embed — you open manage.iccandle.site with identifier as a URL search parameter.

    Use the same identifier string in both places so users and the broker's management page stay linked.

    Recommendation: use each broker's own unique value from your system (for example their broker ID or code) as the identifier, so it stays stable and easy to map back to that broker.

Step 1 — Log in to the Uptech manager​

  1. Open https://manager-uptech.iccandle.site in your browser.
  2. Sign in with the username and password iCCandle provided to you. You do not need to create an account yourself — if you have not received credentials, contact iCCandle.

This dashboard is your control center. You will return to it in Step 5 to manage brokers.

Details: Admin

Step 2 — Create an API key (only once)​

  1. After logging in, open the API Keys tab in the dashboard.
  2. Create a new API key — you will need it in Steps 3 and 4.
caution

Create it once, reuse it in every broker. You only need one API key for your whole platform. Do not create a separate key for each broker. Every broker uses this same key; brokers are told apart by their identifier (next step), not by different keys.

Keep the API key secret — use it only from your backend server, never in a public website or mobile app.

Details: API Keys

Step 3 — Sign users in under each broker (seamless authentication)​

Now you can use the API key from Step 2 to authenticate end users for every broker. The API key stays the same for all brokers; the only thing that changes is the identifier, which tells iCCandle which broker the user belongs to.

To sign a user in, your backend sends a POST request to:

POST https://api.iccandle.ai/seamless/get-user-token-sub-org
X-Api-Key: YOUR_API_KEY
Content-Type: application/json

with the user's email and the broker's identifier in the body:

{
  "email": "tergeluser3@gmail.com",
  "identifier": "A broker"
}

What this request does:

  • If the user does not exist yet, iCCandle creates them; if they already exist, iCCandle signs them in.
  • The user is linked to the broker named in identifier — in the example above, tergeluser3@gmail.com now belongs to A broker.
  • The response contains the user's session tokens, which you use to load the iCCandle widget for that user.

To sign in a user for a different broker, send the exact same request with the same API key but that broker's own identifier (for example B broker).

tip

Sending a new identifier here creates that broker under your API key's platform (if it does not exist yet). Opening the Step 4 embed with the same identifier search param does the same.

Details: Seamless auth (sub-org)

Step 4 — Give each broker a management web interface (iframe)​

Each broker needs a way to see and manage their own users. iCCandle provides a ready-made web page for this, which you embed in your broker's site with an <iframe>.

Build the URL from the same API key (Step 2) and that broker's identifier (Step 3). Both values are URL search parameters — identifier is what creates / selects the broker on that API key's platform:

https://manage.iccandle.site/?apikey=YOUR_API_KEY&identifier=YOUR_IDENTIFIER

For example, for the broker A broker:

<iframe
  src="https://manage.iccandle.site/?apikey=YOUR_API_KEY&identifier=A%20broker"
  width="100%"
  height="800"
></iframe>

If this identifier has never been used with this API key before, opening the URL creates the broker on your platform automatically (same as sending it in the seamless auth request in Step 3).

Inside this page, the broker can:

  • See their users — everyone who was authenticated with that identifier in Step 3
  • Grant a plan (Standard, Pro, or Expert) to any of their users
  • See their iCCandle bundle balance — the credits they have left for granting plans

Because the identifier is different for each broker, each broker only ever sees their own users.

Details: Clients / Brokers

Step 5 — Manage your brokers from the Uptech manager​

Once your brokers are integrated, go back to https://manager-uptech.iccandle.site (the dashboard from Step 1). From here, as the platform owner, you can:

  • Top up a broker's balance — add credits to a broker's iCCandle bundle so they have credits to grant plans in Step 4
  • See how many users each broker has — the count of seamlessly authenticated users per broker (per identifier)

Details: Top Up Clients · Client Statistics

Quick checklist​

StepWhereWhat to do
1manager-uptech.iccandle.siteLog in with the credentials iCCandle gave you
2API Keys tabCreate one API key and save it
3Your backendPOST to get-user-token-sub-org with the user's email + the broker's identifier
4Broker's websiteEmbed https://manage.iccandle.site/?apikey=…&identifier=… in an iframe
5manager-uptech.iccandle.siteTop up broker balances and view each broker's user count