M4 API

From Kolmisoft Wiki
Revision as of 11:35, 6 November 2017 by Ricardass (talk | contribs)
Jump to navigationJump to search
"api"



About

M2 API lets other software interact with M2 without knowing the internal structure of the database (DB) and other logic.

M2 accepts requests by HTML POST and returns results in XML.



M2 users that are allowed to use M2 API

  • Admin
  • Manager - only by using Admin Hash and Secret key
  • Simple User



Functions

API Related


Balance

Various methods to retrieve User balance


Calls

  • user_calls_get (user_calls) – retrieves a list of calls in a selected time period for a user/device.


Currencies


Device


Login

Payments


Rates


Statistics


User


HTML POST

All requests are in a similar format:

HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username
  • username - the user name and password of the user who is asking for the data.

If the user has 'admin' rights, he will get more results and can perform more actions compared to a user who does not have such rights.

Useful to know

  • All API methods returns data straight from database. It means that MOR GUI settings does not affect data, it will be returned as it is saved in database. For example:



See also