Actions

Difference between revisions of "Plugins/Auth/WebServices"

From Mahara Wiki

< Plugins‎ | Auth
(Created page with "=Web Services support for Mahara=")
 
Line 1: Line 1:
 
=Web Services support for Mahara=
 
=Web Services support for Mahara=
 +
 +
#Artefact Webservices#
 +
 +
[Web Services](https://gitorious.org/mahara-contrib/artefact-webservice) support for Mahara.
 +
 +
The Web Services support is based on the webservices subsystem for Moodle and provides REST, XML-RPC, and SOAP alternatives for any registered function.  The REST interface also supports JSON.
 +
 +
##Installation Instructions
 +
This requires the simple authentication module auth/webservice
 +
See https://gitorious.org/mahara-contrib/auth-webservice
 +
 +
To install you need to download both modules:
 +
 +
get https://gitorious.org/mahara-contrib/artefact-webservice/archive-tarball/master
 +
and https://gitorious.org/mahara-contrib/auth-webservice/archive-tarball/master
 +
 +
Then do the following:
 +
 +
`cd /path/to/mahara/htdocs/auth`
 +
`tar -xzf /path/to/mahara-contrib-auth-webservice-master.tar.gz`
 +
`mv mahara-contrib-auth-webservice webservice`
 +
`cd /path/to/mahara/htdocs/artefact`
 +
`tar -xzf /path/to/mahara-contrib-artefact-webservice-master.tar.gz`
 +
`mv mahara-contrib-artefact-webservice webservice`
 +
 +
You should now have the two necessary modules in place.
 +
Now login as admin to Mahara, and go through the upgrade process to complete the install.
 +
In order to make the auth/webservice module available, you should add this as an authentication plugin for each Institution that requires access.  Do this via the admin/users/institutions.php page.
 +
 +
## Testing
 +
 +
## Developing Functions for Services
 +
 +
## Example Clients
 +
 +
## Core Function Interfaces

Revision as of 19:11, 22 June 2011

Web Services support for Mahara

  1. Artefact Webservices#

[Web Services](https://gitorious.org/mahara-contrib/artefact-webservice) support for Mahara.

The Web Services support is based on the webservices subsystem for Moodle and provides REST, XML-RPC, and SOAP alternatives for any registered function. The REST interface also supports JSON.

    1. Installation Instructions

This requires the simple authentication module auth/webservice See https://gitorious.org/mahara-contrib/auth-webservice

To install you need to download both modules:

get https://gitorious.org/mahara-contrib/artefact-webservice/archive-tarball/master and https://gitorious.org/mahara-contrib/auth-webservice/archive-tarball/master

Then do the following:

`cd /path/to/mahara/htdocs/auth` `tar -xzf /path/to/mahara-contrib-auth-webservice-master.tar.gz` `mv mahara-contrib-auth-webservice webservice` `cd /path/to/mahara/htdocs/artefact` `tar -xzf /path/to/mahara-contrib-artefact-webservice-master.tar.gz` `mv mahara-contrib-artefact-webservice webservice`

You should now have the two necessary modules in place. Now login as admin to Mahara, and go through the upgrade process to complete the install. In order to make the auth/webservice module available, you should add this as an authentication plugin for each Institution that requires access. Do this via the admin/users/institutions.php page.

    1. Testing
    1. Developing Functions for Services
    1. Example Clients
    1. Core Function Interfaces