Difference between revisions of "MOR API"
From Kolmisoft Wiki
Jump to navigationJump to search
| Line 1: | Line 1: | ||
MOR API lets other software interact | 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 | MOR accepts requests by HTML POST and returns results in XML. | ||
| Line 9: | Line 9: | ||
== API Related == | == API Related == | ||
* [[API Configuration]] - configuration options for API | * [[API Configuration]] - configuration options for API. | ||
* [[MOR API hash construction|Hash construction]] - | * [[MOR API hash construction|Hash construction]] - how to construct hash to authenticate data over API. | ||
==Login== | ==Login== | ||
* [[MOR API login|login]] - Logs in | * [[MOR API login|login]] - Logs user in to MOR. | ||
* [[MOR API logout|logout]] - Logs out | * [[MOR API logout|logout]] - Logs user out from MOR. | ||
==Details== | ==Details== | ||
* [[MOR API user_details | user_details]] - | * [[MOR API user_details | user_details]] - gets user details. | ||
==Callback== | ==Callback== | ||
* [[MOR API callback|callback]] - Initiates callback | * [[MOR API callback|callback]] - Initiates callback. | ||
* [[MOR API c2c_callback|c2c_callback]] - Initiates Click2Call specific callback | * [[MOR API c2c_callback|c2c_callback]] - Initiates Click2Call specific callback. | ||
==Accounting== | ==Accounting== | ||
* [[MOR API invoices|invoices]] - | * [[MOR API invoices|invoices]] - retrieves a list of invoices in a selected time period. | ||
==Calls== | ==Calls== | ||
* [[MOR API calls|calls]] - | * [[MOR API calls|calls]] - retrieves a list of calls in a selected time period for a user/device. | ||
| Line 39: | Line 39: | ||
=HTML POST= | =HTML POST= | ||
All requests are in similar format: | All requests are in a similar format: | ||
HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username&p=password | HTML POST: http://<SERVER_IP>/billing/api/<function>?u=username&p=password | ||
* username/password - of the user who is asking for the data. | * username/password - the user name and password of the user who is asking for the data. | ||
If user has 'admin' rights | 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. | ||
<br><br><hr> | <br><br><hr> | ||
Revision as of 01:44, 23 May 2010
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
Details
- user_details - gets user details.
Callback
- callback - Initiates callback.
- c2c_callback - Initiates Click2Call specific callback.
Accounting
- invoices - retrieves a list of invoices in a selected time period.
Calls
- calls - retrieves a list of calls in a selected time period for a user/device.
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.
API specification to be implemented in the future
