¶ Integration
¶ Invite Flows
When not integrated with the broker’s partner programme, cTrader Invite involves extra steps for both IBs and traders, and synchronisation of referral statistics becomes challenging.
Figure 1: cTrader Invite before integration
The integration allows brokers to streamline IB and trader flows while automating the data exchange between the cTrader application and the broker CRM.
Figure 2: cTrader Invite after integration
Specifically, the integrated Invite involves the following steps:
1. An IB shares an invite link from their broker-branded cTrader application with a trader.
Invite links stimulate trader engagement by directing traders to specific trading products, such as algorithms, copy strategies, signal links and more.
2. Upon clicking the partner’s invite link, the trader opens cTrader, registers if new, and attribution occurs within the application.
3. The broker CRM receives a webhook with attribution information containing the user IDs of the invited trader and partner, broker name and partner ID.
4. The broker CRM registers the new user and attributes them to the corresponding IB in their system. If the IB is new, they undergo registration in the CRM under the broker’s conditions.
- If the IB is receiving attribution for the first time, the broker CRM generates a new partner ID, which is sent to the cTrader backend and automatically set in cTrader Invite.
- If the IB received attribution in the past (meaning they already have a partner ID), the broker CRM should recognise them, as the webhook sent by the cTrader backend contains known identifiers.
This process keeps the broker CRM in synchronisation with cTrader, allowing real-time referral statistics to be displayed within the application
¶ Integration Process
1. To receive webhooks, a broker must notify the Spotware Support Team (support@spotware.com) of the unique URL in their backend that is prepared to receive attribution information.
2. Support receiving callbacks with attribution information containing invitedUserId, partnerUserId, brokerName and brokerPartnerId from the cTrader backend.
invitedUserId- unique user ID of the invited trader.partnerUserId- unique user ID of the partner.brokerName- name of the broker or white label the user registers with.brokerPartnerId- unique ID of the IB in the broker CRM or partner programme.
3. Support sending responses containing brokerPartnerId and brokerResult to the cTrader backend.
brokerResult- status of the attribution process. See the response body in this API call for more information on this key.
¶ Optional Steps
4. Support sending requests and then receiving history of attributions from the cTrader backend via this API call.
5. Support receiving callback notifications from the cTrader backend about the registration of a new user via this API call and notify Spotware about the URL in the broker’s backend prepared for this purpose. This enables brokers to learn about new users who register directly in a cTrader application, as the cTrader backend does not automatically return such users’ userId to the broker CRM.
6. Support sending requests via this API call and receiving responses containing all registered users or users registered within a specified timeframe.
Note: The Invite functionality described in this document can be used independently from the WebServices API call 8.6 and the Broker SSO API call 3.6.