Difference between revisions of "MOR integration"
From Kolmisoft Wiki
Jump to navigationJump to search
Line 41: | Line 41: | ||
*[[MOR_API_invoices_get|Invoices]] - retrieves a list of invoices in a selected time period | *[[MOR_API_invoices_get|Invoices]] - retrieves a list of invoices in a selected time period | ||
*[[MOR_API_user_balance_get|Balance]] - retrieves a user balance | *[[MOR_API_user_balance_get|Balance]] - retrieves a user balance | ||
*[[ | *[[MOR_API_rate_get|Rate]] - check user rate for a phone number prefix | ||
Revision as of 08:08, 25 May 2013
About
This page is dedicated for programmers who are integrating MOR into other products or modifying MOR GUI.
Facts about MOR
Technologies used
- Ruby on Rails - GUI
- MySQL - used for data storage
- Asterisk - used for interconnecting the calls.
- CentOS Linux - platform. Other Linux distributions might work but are not supported by Kolmisoft.
- Apache - a web server
MOR Development Machine
We advise you to create a development machine where you could test your changes. A development machine can be prepared by following this guide:
It will be a fully functioning MOR system with a 2 calls limit.
MOR API
Reasons to use MOR API
- MOR API allows you to perform some operations without modifying the GUI - does not require any Ruby on Rails knowledge.
- MOR API can be used in any programming language which supports sending POST requests.
- When you modify a GUI directly - each time MOR system is updated - your changes are overwritten by MOR upgrade scripts. Your changes are backuped and it is your responsibility to merge those changes back.
MOR users that are allowed to use MOR API
- Admin
- Reseller
- Accountant
Operations supported by MOR API
- User registration
- Login / Logout
- Callback - can be used to initiate a call from your application
- Invoices - retrieves a list of invoices in a selected time period
- Balance - retrieves a user balance
- Rate - check user rate for a phone number prefix
And many more...
A full MOR API documentation is available here.
Sending a POST request in various programming languages to MOR
Remember, you have to send your requests to MOR's URL. No libraries provided by Kolmisoft are needed to send POST requests to MOR. Every programming language provides it's own libraries for this task.
Facts/commands you should know
- MOR GUI is located in /home/mor and can be accessed using a SSH supporting client like Filezilla
- When you modify a ruby code - you have to restart the web server for the changes to take effect:
/etc/init.d/httpd restart
- PhpMyAdmin is available at address: http://SERVER_IP/phpmyadmin and password from it can be found using this command in server:
[root@localhost ~]# cat /root/phpMyAdminPassword Login and Password from phpMyAdmin system: admin t5Hg1PR1yu
- Changes in /home/mor/public are not overwritten during updates - that allows you to change default MOR images and CSS.
- Using this command you can determine a current MOR version and revision:
svn info /home/mor
Useful tools
- When your changes are overwritten by MOR upgrade scripts - you can restore them easier with merge tools like: Winmerge which shows you the differences between files and allows you to merge as you go.
Custom features development
Your custom developed MOR features can be integrated into main code base.
Please check here for requirements in order the features would be integrated.
Other information sources about MOR