Difference between revisions of "M4 API"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 106: Line 106:
<br><br>
<br><br>
=See also =
=See also =
* [[M2 API Configuration]]
* [[M4 API Configuration]]
* [[MOR integration]]
* [[MOR integration]]
* [[How to block access to some API functions]]
* [[How to block access to some API functions]]
* [[API specification to be implemented in the future]]
* [[API specification to be implemented in the future]]

Revision as of 11:07, 28 November 2022

"api"



About

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

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



M4 users that are allowed to use M4 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 / Connection Point


Number Pools


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 username 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 return data straight from the database. It means that MOR GUI settings do not affect data, it will be returned as it is saved in the database. For example:



See also