IB/Affiliate system - API registration and tracking

Created: 3/31/2021 | Updated: 3/31/2021 | Status: Published
The below instructions are related to operators that are using AffiliateTS (affiliate Buddies) IB/Affiliate management system, and would like to allow their affiliates to register users directly to our system via API, but also track them in the IB/Affiliate system.


Instructions to link affiliate API user in IB/Affiliate system


Step 1 (Affiliate System): Register the user in the affiliate system


Step 2 (CRM): Create a CRM user and request us to grant him API access


Step 3: Register a user via API

Example of registration call:


https://admin-api.hk-a.tradesmarter.com/crm/rest/register?email=test502@gc.trade&sendConfirmationEmail=1&currency=usd&password=94693e6ad8410783640b3c68c166597c&firstName=Ben&lastName=Test&phone=12345678&country=th&confirmed=0&siteID=208&practiceMode=0&locale=en_TH&landing=%7B%22btag%22:%22a502-b1-p0-cIE-u94956716001616722360%22%2C%22campaign%22:%221%22%2C%22a_aid%22:%22502%22%2C%22serial%22:%22General_Link_to_Client_site--English%22%2C%22utm_source%22:%22affiliateBuddies%22%2C%22utm_campaign%22:%22XXaffiliate2C%22utm_medium%22:%22affiliate%22%2C%22utm_term%22:%22502%22%2C%22utm_content%22:%221%22}


Notes:

password = pass in MD5 format. (mandatory)

pass = regular format - 7-10 characters, at least one upper, one digit.

(mandatory only when MT4/5 is configured for the brand)

landing = For internal tracking and reporting, please make sure to add the ‘landing’ param with your relevant details:

{%22btag%22:%22a502-b1-p0-cIE-u94956716001616722360%22%2C%22campaign%22:%221%22%2C%22a_aid%22:%22502%22%2C%22serial%22:%22General_Link_to_Client_site--English%22%2C%22utm_source%22:%22affiliateBuddies%22%2C%22utm_campaign%22:%22XXaffiliate%22%2C%22utm_medium%22:%22affiliate%22%2C%22utm_term%22:%22502%22%2C%22utm_content%22:%221%22}


The landing param must contain the above parameters for full tracking. The affiliate can edit them to reflect his own dynamic campaigns.
If you only looking for registration tracking the affiliate should use {%22a_aid%22:%22502%22%2C%22btag%22:%22a502-b01-p%22}