Difference between revisions of "M4 API"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(One intermediate revision by one other user not shown)
Line 86: Line 86:


==User==
==User==
* [[M4 API user_create | user_create]] - creates user.
* [[M4 API user_details_get | user_details_get]] (user_details) – gets user details.
* [[M4 API user_details_get | user_details_get]] (user_details) – gets user details.
* [[M4 API user_delete | user_delete]] - deletes user.
* [[M4 API user_delete | user_delete]] - deletes user.
* [[M4 API users_get | users_get]] - get user list.
* [[M4 API users_get | users_get]] - get user list.
* [[M4 API user_details_raw_get | user_details_raw_get]] - get raw details of the User from the DB.
* [[M4 API user_details_raw_get | user_details_raw_get]] - get raw details of the User from the DB.
* [[M4 API user details update | user_details_update]] - update User's details


<br>
<br>

Latest revision as of 11:24, 12 March 2024

"api"



About

M4 API lets other software interact with M4 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 M4 GUI settings do not affect data, it will be returned as it is saved in the database. For example:



See also