Difference between revisions of "M4 API"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 44: Line 44:
* [[M2 API devices get | devices_get]] (device_list) – users device list
* [[M2 API devices get | devices_get]] (device_list) – users device list
* [[M2 API device details get | device_details_get]] – shows all information about specified device.
* [[M2 API device details get | device_details_get]] – shows all information about specified device.
* [[M4_API_cp_create | cp_create]] - creates a connection point
* [[M4_API_cp_update | cp_update]] - updates a connection point
* [[M4_API_cp_delete | cp_delete]] - deletes a connection point
<br>
<br>



Revision as of 12:46, 7 November 2022

"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


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 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