Actions

Difference between revisions of "Artefact/WebServices/WebServicesConfiguration"

From Mahara Wiki

Line 9: Line 9:
 
From here, you can carry out all the main administrative tasks:
 
From here, you can carry out all the main administrative tasks:
  
* Globally activate/deactivate web services
+
* Globally activate/deactivate web services
* activate/deactivate individual protocols (REST, SOAP, XML-RPC)
+
* activate/deactivate individual protocols (REST, SOAP, XML-RPC)
* Create Services Groups of Functions that can be accessed
+
* Create Services Groups of Functions that can be accessed
* Generate access tokens, and allocate users, and services groups
+
* Generate access tokens, and allocate users, and services groups
* Grant access to users for simple authentication access, and allocate service groups
+
* Grant access to users for simple authentication access, and allocate service groups
* look up API descriptions for functions
+
* look up API descriptions for functions
  
 
== Global activation ==
 
== Global activation ==

Revision as of 09:32, 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:

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

Service Groups

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

Token Based Access Control

Simple User Authentication Access Control