How to Create a New Affiliate?

Published: 2024-02-12 08:11:11
312 views
Training and Educational Resources

The articles you may find useful for you: How to Check the API Logs?


IN THE CRM

Where to find the API docs link?


1. Go to "Setup" in the left menu.



2. Go to "Settings.



3. Go to "Modules" and chose "API".



3. Choose "Yes" in "Enable Public Access to API Documentation". You can copy your API docs link now. If the setting is OFF/NO, the affiliate won't be able to access the documentation.



4. Press "Save".



Creating the API source


1. Go to "Setup" in the left menu.



2. Press the "Leads" button and select "Sources" from the dropdown list.



3. Press the "New Source" button to create a new source.



4. Fill in the columns and press "Submit". Depending on the Department or Assigned, the leads will be assigned accordingly to the chosen Department or Agent.



Creating New API user


5. Go to the main menu and click "API" and select "API management" from the dropdown list.



6. Press the "New User" button.



7. Fill in the information about the new user.

The source name, the username and the affiliate name should be all the same (refer to the name of the source you've just created). 
Set an expiring date. Note when the date arrives, the integration will be paused until you extend it.



8. Optionally:

-You can also set up permissions.

Note that if you enable permissions without choosing any, the affiliate will have the full access by default which may be dangerous for your information. To give the API some special permissions, just match them on the "Permissions" and save your choice.



9. Optionally:

-You can add the IP whitelisting if the affiliate needs it. Enable the function and press on the "IP Whitelist" to add the required IPs.



10. Optionally:

-Open Trading account set automatically will open the trading account for each lead coming. By default it will have 123456 password.

If your affiliation type is CPL, the trading account will not be automatically open. If CPA, the trading account will be automatically open for the lead.



11. Press "Save".



12. Fill in the form using the information from the newly created user and send it to your affiliate. Do not omit/ignore the fields.

Note! "YOURCRM" refers to your crm link, so that where the leads are going to arrive to. Same for the API docs, as the affiliate must be able to see them.


This information is to be sent to the affiliate once filled in
Tech provider: Nanza CRM
integration type: Nanza- AutoLogin

✨API-Docs: https://back.YOURCRM/api/docs

Base URL: https://back.YOURCRMo/admin/

source ID: the most right figure in your affiliation list
User: the name of your affiliate
Token: the token generated withing the new affiliation


Leave the warning text for the affiliate:
‼️do not put "source" and "source_id" in the affiliation form. choose only "source_id"
‼️make sure the affiliate name has no spaces
‼️after the test lead is sent, make sure to send next requests with username:""


How to Fire FTD/Change Lead Status

Fire FTD (a First Time Deposit) - after the affiliate integration has taken place, the "fire FTD" means that the affiliate test lead has arrived in the client's CRM.

You don't have to manually add the deposit/funds.

If your affiliation type is CPL, the trading account will not be automatically open. If CPA, the trading account will be automatically open.


13. The affiliate will note you and warn that the lead was sent. Find the lead email in the CRM which was sent by the affiliate.



14. To "fire FTD" press on "Convert to Trader" and "Open Trading account" buttons.

If you enabled "Open Trading Account" you won't see the blue button and would have to only enable the green one.



14. Update the affiliated about firing. The affiliate would approve it from their side. The integration is done, you can continue the collaboration!



Did you find this article useful?

 
0 Console 0.0338 s Load Time 2.35 MB Memory Used 25 Queries Database 0 Eloquent Illuminate\Database vars & Config 366 Files