Difference between revisions of "MOR API"
From Kolmisoft Wiki
Jump to navigationJump to search
| Line 71: | Line 71: | ||
==Credit notes== | ==Credit notes== | ||
* [[MOR API credit_notes_list_api| | * [[MOR API credit_notes_list_api| credit_notes]] - credit notes list. | ||
* [[MOR API credit_note_update_api| credit_note_update]] - credit note update. | * [[MOR API credit_note_update_api| credit_note_update]] - credit note update. | ||
* [[MOR API credit_notes_create_api| credit_note_create]] - credit note create. | * [[MOR API credit_notes_create_api| credit_note_create]] - credit note create. | ||
| Line 78: | Line 78: | ||
==Financial statements== | ==Financial statements== | ||
* [[MOR API financial_statements_list_api| | * [[MOR API financial_statements_list_api| financial_statements]] - financial statements list. | ||
<br> | <br> | ||
Revision as of 13:24, 12 January 2012
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
- Reseller
- Accountant
Functions
API Related
- API Configuration - configuration options for API.
- Hash construction - how to construct hash to authenticate data over API.
Login
User
- user_register - create new user from params.
- 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
Rates
- rate - check user rate by prefix
- get_tariff - get all tariff's rates
- import_tariff_retail - import xml retail tariff
Device
- device_create - create device
- delete_device - delete device
Phonebooks
- phonebooks_api - phonebooks list.
- phonebook_edit_api - edit phonebook.
Payments list
- payments_list - payments list.
Credit notes
- credit_notes - credit notes list.
- credit_note_update - credit note update.
- credit_note_create - credit note create.
- credit_note_delete - credit note delete.
Financial statements
- financial_statements - financial statements list.
Examples
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.
