Start a conversation

Developers API

Developers API manual

  • Introduction to MLM Soft API

    Request structure URL schema: // host / gateway / entity / method? parameters Example: http://api2.dev/main-app/payment-system/fill-up/start In this example: http - schema api2.dev - host main-app - g...

  • Authorization

    All requests from the Online Office subsystem should contain a token in the header, which is written in the configuration of this subsystem during the installation. Initially, token is generated by an...

  • Account

    1) account/add-to-tree A method that adds an account to the specified tree. As a result, the position is formed. Method - POST https://.../online-office/account/add-to-tree Request parameters Paramete...

  • API

    api/methods Request returns available methods and parameters for the current gateway. Method - GET URL - https://.../online-office/api/methods...

  • Country

    country/get-list This method returns the list of countries. Sample request http://.../main-app/country/get-list?withRegions=0 Parameter withRegions. Optional, can be 0 or 1. The default is 1. Response...

  • Currency

    currency/get-list The method that returns a list of currencies. URL - $APIURL/online-office/currency/get-list Response parameters Parameter Type Value List Array Currency list...

  • Currency rate

    1) currency-rate/get-current The method returns a list of currency rates. URL -  $APIURL/online-office/currency-rate/get-current Response parameters Parameter Type Mandatory field Value currencyId Arr...

  • Dictionary

    dictionary/get-values URL - $APIURL/online-office/country/dictionary/get-values?alias=Marital_status Sample request http://.../main-app/dictionary/get-values?alias=Marital_status Parameter Dictionary ...

  • Metric

    1) metric/get-data The method returns data for drawing the graph. Now for the selected type of js library the necessary data is returned in a convenient format. Метод - POST. URL - https://.../online-...

  • Payment rule

    payment-rule/get-list The method returns a list of payment rules found by the specified parameters. Method - POST URL - https://.../online-office/payment-rule/get-list Request parameters Parameter Typ...