Difference between revisions of "M4 API"
From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with 'right|alt="api"|link= <mkmeta>Application Program Interface for MOR Class 5 Softswitch</mkmeta> <br><br> =About= MOR API lets other software interact with MOR w…') |
|||
| Line 24: | Line 24: | ||
<br> | <br> | ||
==Balance== | ==Balance== | ||
* [[ | * [[M2 API user balance update | user_balance_update]] (change_user_balance) – changes User's Balance | ||
Various methods to retrieve User balance | Various methods to retrieve User balance | ||
* [[ | * [[M2 API user_balance_get|user_balance_get]] (balance) – retrieves a User Balance. | ||
* [[Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance | * [[M2 Balance in phone | user_simple_balance_get]] (simple_balance) – gets User's Balance | ||
<br> | <br> | ||
==Calls== | ==Calls== | ||
* [[ | * [[M2 API user calls get|user_calls_get]] (user_calls) – retrieves a list of calls in a selected time period for a user/device. | ||
<br> | <br> | ||
==Device== | ==Device== | ||
* [[ | * [[M2 API devices get | devices_get]] (device_list) – users device list | ||
<br> | <br> | ||
==Login== | ==Login== | ||
* [[ | * [[M2 API user_login|user_login]] (login) – logs user in to MOR. | ||
* [[ | * [[M2 API user_logout|user_logout]] (logout) – logs user out from MOR. | ||
<br> | <br> | ||
==Rates== | ==Rates== | ||
* [[ | * [[M2 API tariff rates get| tariff_rates_get]] (get_tariff) – get all tariff's rates | ||
* [[ | * [[M2 API tariff_wholesale_update | tariff_wholesale_update ]] (wholesale_tariff) – update or create wholesale tariff | ||
<br> | <br> | ||
==User== | ==User== | ||
* [[ | * [[M2 API user_details_get | user_details_get]] (user_details) – gets user details. | ||
<br> | <br> | ||
Revision as of 08:51, 31 December 2015
About
MOR API lets other software interact with MOR without knowing the internal structure of the database (DB) and other logic.
MOR accepts requests by HTML POST and returns results in XML.
MOR users that are allowed to use MOR API
- Admin
- Manager - only by using Admin Hash and Secret key
- Simple User
Functions
API Related
- API Configuration – configuration options for API.
- Hash construction – how to construct hash to authenticate data over API.
Balance
- user_balance_update (change_user_balance) – changes User's Balance
Various methods to retrieve User balance
- user_balance_get (balance) – retrieves a User Balance.
- user_simple_balance_get (simple_balance) – gets User's Balance
Calls
- user_calls_get (user_calls) – retrieves a list of calls in a selected time period for a user/device.
Device
- devices_get (device_list) – users device list
Login
- user_login (login) – logs user in to MOR.
- user_logout (logout) – logs user out from MOR.
Rates
- tariff_rates_get (get_tariff) – get all tariff's rates
- tariff_wholesale_update (wholesale_tariff) – update or create wholesale tariff
User
- user_details_get (user_details) – gets user details.
Examples
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:
- Value of money will be returned in Default System Currency.
- Date will not be affected of Default date format setting.
- Value of money will not be affected of Number digits setting.
