xRest API (With plugin function utilities) for XOOPS


X-REST

Download: http://sourceforge.net/projects/chronolabs/files/XOOPS%202.5/Modules/xoops2.5_xrest_1.60.zip/download

XOOPS SVN: https://sourceforge.net/p/xoops/svn/HEAD/tree/XoopsModules/xrest/

X-REST 1.50 is a REST API for XOOPS 2.x series. It will work with earlier version of xoops as well upto XOOPS 2.5. It provides a full REST API with JSON, XML and Serialisation Responses. It uses the standard plugin set for the other APIs as well as this one to provide a streamlined solution to APIs on your site, the plugins are compatible with all other API by chronolabs. You may be familar with a REST api such as the ones at Google, Twitter, Facebook etc, this is just the same but allowing for API Action on your own website.

There is two reserved variables on the REST API which are the following: xrestplugin & outputmode.

To call a REST API Function you must know the filename of the plugin, say it is called plugin.php then the following call will call the function on the API. ./xrest/plugin/?var1=example1&var2=example2 or for an XML response you would call ./xrest/plugin/xml/?var1=example1&var2=example2 and of course for PHP Serialisation you could call ./xrest/plugin/serial/?var1=example1&var2=example2 – you can also POST to the api where you can call the following folder for the plugin function http://yoursite.com/modules/xrest/plugin/ where the variables defined in the plugins XSD var1 and var2 are posted using cURL or other systems headers. In this example the variable xrestplugin would equal plugin. You can change the output mode where JSON is the default, by specifying in the variables outputmode=xml for xml output, outputmode=serial for PHP Serilisation output and the standard where you don’t need to specify is JSON for outputmode=json for JSON output.

New Features Include:

  • XOOPS 2.5 GUI with About & Dashboard
  • Cache Cleanup Preloader
  • Result Cache
  • XOOPS Blue Room Classes
  • Database Access permissioning (Needs to be implemented in plugin)
  • XOOPS User Permissions
  • XOOPS Group Permissions
  • Universal Plugin Set

Installation

Download the lastest version from Chronolabs on Google code or off sourceforge. Unzip the archive you should have a folder called ‘htdocs’ in the unzipped location. Copy the contents of ‘htdocs’ folder to your CMS root path this is generally a folder called ‘public_html’ or ‘www’ on your FTP service of your website. Log into your CMS and goto the modules/applications installation section, this is generally in your system control area under modules. Click on the icon that represent installing the module. If all has behaved as need be then your module is installed. If your module requires a user licences, keys or a username then sign-up to the apprpriate sites and retreieve your keys or IDs (Links should be provided in the preferences) and paste the values into preferences. Now your right to go!

Upgrading

Download the lastest version from Chronolabs on Google code or off sourceforge. Unzip the archive you should have a folder called ‘htdocs’ in the unzipped location. Copy the contents of ‘htdocs’ folder to your CMS root path this is generally a folder called ‘public_html’ or ‘www’ on your FTP service of your website. Log into your CMS and goto the modules/applications installation section, this is generally in your system control area under modules. Click on the icon that represent upgrading the module. Your version number should no longer be in bold and would have changed!

Reporting a Bug

The google code section has an area for reporting bugs called issues. Any issue or bug you believe you are having that is not a result of your site services then please report it here. The URL for reporting bugs is as follows: https://sourceforge.net/p/chronolabs/tickets/?source=navbar

Please report the following:

 	a) Version of CMS 
 	b) Version of PHP
 	c) Version of MySQL
 	d) Services Software ie. Apache, Zeus etc.
 	e) Version of Software 
 	f) Error Messages 
 	g) Steps to reproduce 
 	e) Contact details for the team to get in touch should they need!

System Requirements:

  • XOOPS 2.5.x
Advertisements

Leave a Rant, Expressive Annotation or Disgust or Give a Bonus Star-run Review or a shit house response!

Please log in using one of these methods to post your comment:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s