Artefact/WebServices/WebServicesConfiguration

Web Services Configuration

All Web Services configuration hangs off the plugin administration page http://your.mahara.local.net/artefact/webservice/pluginconfig.php

The main page:

Web Services main configuration page

From here, you can carry out all the main administrative tasks:

• Globally activate/deactivate web services
• activate/deactivate individual protocols (REST, SOAP, XML-RPC)
• Create Services Groups of Functions that can be accessed
• Generate access tokens, and allocate users, and services groups
• Grant access to users for simple authentication access, and allocate service groups
• look up API descriptions for functions

Global activation

Globally activate or deactivate all web service access for when you need to shut off access completely

Global activation/deactivation of all web services

Activating Protocols

Individual protocols can be activated or deactivated. Once activated, the protocol is available to all configured functions/users/tokens.

Available protocols are:

• SOAP
• REST (a basic HTTP and forms POST based interface)
• XML-RPC

activate and deactivate inidividual protocols

Service Groups

Service groups are the unit of allocation of access to a user (simple auth) or user token. They are a collection of functions.

Web Services service groups

Give a service group a name, and then specify what functions are to be included. You must also decide what form of authentication can access this service group - web service token, or user simple auth (user and password).

edit service group

Function API Descriptions

From the Service Group editing view, there is a link to each API function that will take you to a description of the functions API - input/output parameters, and error handling.

Web Services Group Delete API description