Related: How to Check the API Logs? · How to Set Up Delayed API Convert? · How the Affiliate Management module works?
This guide is for API lead-source affiliates (partners who push leads into your CRM). It is not the client-referral Affiliate Management module.
IN THE CRM
1) Enable public API documentation
1. Go to Setup → Settings.
2. Open the API settings tab (not Setup → Modules).
3. Set Enable Public Access to API Documentation to Yes.
4. Copy the Public API Documentation URL shown on that page (format: https://YOUR-CRM-DOMAIN/api/docs). If this is off, the affiliate cannot open the docs without an admin login.
5. Press Save.
2) Create the lead source
1. Go to Setup → Leads → Sources.
2. Press New Source.
3. Enter the affiliate/source name (prefer no spaces), set Department / Assigned if you want auto-routing, then Submit.
4. Note the source’s numeric ID from the Sources list (or from the Source field after you link it on the API user). That ID is what you send to the affiliate as source_id — not “the rightmost number in an affiliation list.”
3) Create the API user
1. Go to API → API Management.
2. Press New User.
3. On the Settings tab fill in:
- User — API username (often match the source name; no spaces)
- Name — display name for the affiliate
- Expiration date — when it passes, the integration pauses until you extend it
- Source — select the lead source you just created
- Optional: link a Client if your workflow uses it
4. Optional switches:
- Enable IP whitelisting — only listed IPs may call the API. After save, manage IPs on the IP Whitelist tab.
- Open TA — allows this API user to open a trading account during registration. The affiliate must send a password (and username if they use one). There is no automatic default password such as 123456. For CPL you usually leave this off; for CPA you often turn it on — that is a commercial choice, not a hard CRM rule.
- Enable fine-grained permissions — recommended. When this is off, the token can call any API capability the CRM exposes (other limits like expiry, IP whitelist, and source still apply). When it is on, only checked capabilities are allowed. Turn it on → open the Permissions tab → Apply a starter preset (or select capabilities) → Save.
Important: Turning permissions on with nothing selected does not grant full access — it restricts the token. Full access happens when fine-grained permissions are off.
5. Press Save.
6. From API Management, copy the generated token for this user.
4) Send credentials to the affiliate
Fill every field. Replace YOUR-CRM-DOMAIN with your real CRM host (example: crm.yourcompany.com). Do not use a fake back. subdomain or an /admin/ base URL for the API.
Template to send the affiliate
Tech provider: Nanza CRM
Integration type: Nanza – AutoLogin
API Docs: https://YOUR-CRM-DOMAIN/api/docs
API Base URL: https://YOUR-CRM-DOMAIN/api/
source_id: <numeric lead source ID>
User: <API username>
Token: <API token from API Management>
Auth header: API calls use header Authtoken: <token> (see the public API docs).
Warnings for the affiliate:
‼️ Use source_id (the numeric ID). Do not invent a separate “source” name field alongside it unless your integration docs say both are required.
‼️ Prefer an affiliate/API username with no spaces.
‼️ If Open TA is enabled, send a unique password (and username if used) on registration — do not rely on a shared default password.
‼️ After the first successful test lead, keep using the same Authtoken; do not clear the username on later requests unless your partner’s mapper specifically requires it.
5) Test lead and fire FTD / Convert to trader
See also: How to Set Up Delayed API Convert?
Fire FTD here means confirming the affiliate’s test lead arrived and completing the conversion step they need for CPA approval. You do not need to manually add deposit funds for a basic integration test.
1. Ask the affiliate to send a test lead, then find that lead in the CRM by email.
2. When they ask you to fire FTD / mark conversion, open the lead and use Convert to trader (permission: leads → convert to trader).
3. If Open TA was already used at registration, the trading account may already exist — follow the lead profile actions you see (you may only need the conversion step, not a second “open account” action).
4. Tell the affiliate the conversion is done so they can approve on their side. Integration is ready for live traffic.
Updated to match current Setup → Settings → API, API Management (permissions presets / Open TA), and API Base URL /api/ (not /admin/).