Difference between revisions of "MOR API"
From Kolmisoft Wiki
Jump to navigationJump to search
Line 17: | Line 17: | ||
* [[MOR API logout|logout]] - logs user out from MOR. | * [[MOR API logout|logout]] - logs user out from MOR. | ||
== | ==User== | ||
* [[MOR API user_details | user_details]] - gets user details | * [[MOR API user_details | user_details]] - gets user details | ||
* [[MOR API user_update_api| user_update_api]] - update user from params. | |||
==Callback== | ==Callback== | ||
Line 49: | Line 49: | ||
* [[MOR API user_register| user_register]] - create new user from params. | * [[MOR API user_register| user_register]] - create new user from params. | ||
<br><br> | <br><br> | ||
<br><br> | <br><br> | ||
== | ==Device== | ||
* [[MOR API create_device_api| device_create]] - create device | |||
* [[MOR API delete_device_api| delete_device]] - delete device | |||
<br><br> | <br><br> | ||
==Import XML Retail tariff== | ==Import XML Retail tariff== |
Revision as of 14:37, 21 December 2011
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.
Functions
API Related
- API Configuration - configuration options for API.
- Hash construction - how to construct hash to authenticate data over API.
Login
User
- user_details - gets user details
- user_update_api - update user from params.
Callback
- callback - initiates callback.
- c2c_callback - initiates Click2Call specific callback.
Accounting
- invoices - retrieves a list of invoices in a selected time period.
Calls
- user_calls - retrieves a list of calls in a selected time period for a user/device.
Balance
- balance - retrieves a user balance.
- simple_balance - gets user's balance
- change_user_balance - change user's balance
Rate
- rate - check user rate for prefix.
Registration
- user_register - create new user from params.
Device
- device_create - create device
- delete_device - delete device
Import XML Retail tariff
- import_tariff_retail - import xml retail tariff.
Phonebooks
- phonebooks_api - phonebooks list.
- phonebook_edit_api - edit phonebook.
Payments list
- payments_list - payments list.
Tariff rates
- get_tariff - tariff rates.
HTML POST
All requests are in a similar format:
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username&p=password
- username/password - 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.