Artefact/WebServices/WebServicesConfiguration: Difference between revisions
From Mahara Wiki
PiersHarding (talk | contribs) No edit summary |
PiersHarding (talk | contribs) No edit summary |
||
| Line 21: | Line 21: | ||
Globally activate or deactivate all web service access for when you need to shut off access completely | Globally activate or deactivate all web service access for when you need to shut off access completely | ||
[[File:Webservices-enable-services.png|border | [[File:Webservices-enable-services.png|border|Global activation/deactivation of all web services]] | ||
== Activating Protocols == | == Activating Protocols == | ||
| Line 32: | Line 32: | ||
* XML-RPC | * XML-RPC | ||
[[File:Webservices-enable-protocols.png|border | [[File:Webservices-enable-protocols.png|border|activate and deactivate inidividual protocols]] | ||
<br/> | <br/> | ||
| Line 40: | Line 40: | ||
Service groups are the unit of allocation of access to a user (simple auth) or user token. They are a collection of functions. | Service groups are the unit of allocation of access to a user (simple auth) or user token. They are a collection of functions. | ||
[[File:Webservices-manage-service-groups.png| | [[File:Webservices-manage-service-groups.png|border|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). | 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). | ||
[[File:Webservices-service-group.png| | [[File:Webservices-service-group.png|border|edit service group]] | ||
| Line 52: | Line 52: | ||
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. | 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. | ||
[[File:Webservices-group-delete-api.png| | [[File:Webservices-group-delete-api.png|border|Web Services Group Delete API description]] | ||
== Token Based Access Control == | == Token Based Access Control == | ||
Revision as of 09:56, 23 June 2011
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:
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
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
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.
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).
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.
