Registration

As the MLM Soft API is asynchronous you can not get UserId in response to a user/create requests. To get MLMSoft UserId for future use as a reference for new users registrations and volume assignments there are two options described below.

Type I (Document poll)

On a user's registration your system (referenced as System A) creates a user's record and sends a user/create request to MLMSoft api.  In response your system will get a notification whether the request has been queued and in case of success will return documentId. Your system makes a document/get request to fetch status and MLMSoft UserId. Upon successful completion of document execurion your system will get the MLMSoft UserId that should be stored within the user record for future reference as a Sponsor ID or Volume destination.

Type II (User interaction)

On a user's registration your system (referenced as System A) creates a user's record and sends user/create request to MLMSoft api.  In response your system will get just a notification whether the request has been queued or not. Your system prompts the user for entering email and password and after checking it, sends them in user/check-auth request to MLMSoft api. Upon successful authorisation your system will get MLMSoft UserId that should be stored within the user record for future reference as a Sponsor ID or Volume destination.

Type III (Webhook)

This scenario is quite similar to Type I, except you do not need a user to log in in order to get MLMSoft UserId. As soon as a user/create request was processed in the MLMSoft platform your system will get a notification as HTTP POST request with email and MLMSoft UserId. Your system should keep this UserId in the user’s record for future reference as a Sponsor ID or Volume destination.

Volume change

Volume assignment to specific user’s account is another integration action. As soon as the user makes some volume-generating action, your system should send one or several account/volume change requests to MLMSoft to feed it with required volumes. Requests should send one property per request. Note that order of such requests is very important. Let’s say you pay referral bonuses based on users’ statuses. So, to make correct calculations you need to set status first and then set a volume.