Using web services - Revision history

Tsala: see also link copied from 20 wiki

2011-11-24T08:42:37Z

Tsala: moved How to create and enable a web service to Using web services

2011-11-02T10:10:58Z

moved How to create and enable a web service to Using web services

← Older revision	Revision as of 10:10, 2 November 2011
(No difference)

Tsala: small rewording

2011-11-02T09:54:05Z

small rewording

← Older revision		Revision as of 09:54, 2 November 2011
Line 18:		Line 18:
	== Enabling web service function documentation ==		== Enabling web service function documentation ==
	[[Image:Security keys and documentation.jpg\|thumb\|Security keys page with documentation link]]		[[Image:Security keys and documentation.jpg\|thumb\|Security keys page with documentation link]]
	Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[~~How_to_get_a_security_key\|security~~ keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.		Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[Security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.

	== Creating a service ==		== Creating a service ==
Line 38:		Line 38:
	# Select 'create group' function and click the 'Add functions' button		# Select 'create group' function and click the 'Add functions' button

	You should be back to the service functions list. 'Required capabilities' are indicated for each function. Users need the required capabilities to run a function. The function descriptions in the API Documentation can also give you more information about the required capabilities (''~~Admin~~ > Plugins > Web services > API Documentation'').		You should be back to the service functions list. 'Required capabilities' are indicated for each function. Users need the required capabilities to run a function. The function descriptions in the API Documentation can also give you more information about the required capabilities (''Settings > Site administration > Plugins > Web services > API Documentation'').

	==Enabling capabilities==		==Enabling capabilities==
Line 46:		Line 46:
	* [[Capabilities/moodle/webservice:createtoken\|moodle/webservice:createtoken]] - for allowing users to generate a security key		* [[Capabilities/moodle/webservice:createtoken\|moodle/webservice:createtoken]] - for allowing users to generate a security key
	* [[Capabilities/webservice/rest:use \| webservice/rest:use]], [[Capabilities/webservice/soap:use \| webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use \| webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use \| webservice/amf:use]] which match the enabled protocols.		* [[Capabilities/webservice/rest:use \| webservice/rest:use]], [[Capabilities/webservice/soap:use \| webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use \| webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use \| webservice/amf:use]] which match the enabled protocols.
	* The service ''Required capability'' if set (''Site administration > Plugins > Web services > Manage services >'''Edit''' link'').		* The service ''Required capability'' if set (''Settings > Site administration > Plugins > Web services > Manage services >'''Edit''' link'').
	* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [~~https://docs.moodle.org/en/Manage_roles~~ Manage roles] documentation.		* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [[Manage roles]] documentation.

	Once done, the web service should be set up. Users should be able to [[~~How_to_get_a_security_key~~\|obtain a personal security key]].		Once done, the web service should be set up. Users should be able to [[Security keys\|obtain a personal security key]].

	= Alternative settings =		= Alternative settings =
Line 59:		Line 59:
	# Select some users and click '''Add'''		# Select some users and click '''Add'''

	Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can ~~setup~~ some specific options: ''IP restriction'' and ''Valid until''.		Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can set up some specific options: ''IP restriction'' and ''Valid until''.

	== Create a token ==		== Create a token ==
Line 71:		Line 71:

	As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.		As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.
	Finally, ~~you can~~ note that ~~like~~ for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.		Finally, note that, as for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.

Jmouneyrac: /* Adding functions to the service */

2011-11-02T02:07:15Z

Adding functions to the service

← Older revision		Revision as of 02:07, 2 November 2011
Line 38:		Line 38:
	# Select 'create group' function and click the 'Add functions' button		# Select 'create group' function and click the 'Add functions' button

	You ~~will then~~ be ~~returned~~ to the service functions list. ~~Opposite each function is a~~ 'Required capabilities' ~~field~~. Users need ~~these~~ capabilities to run ~~each~~ function. ~~However there are exceptions - see the~~ function descriptions in the API ~~Documenation~~ (''Admin > Plugins > Web services > API Documentation'').		You should be back to the service functions list. 'Required capabilities' are indicated for each function. Users need the required capabilities to run a function. The function descriptions in the API Documentation can also give you more information about the required capabilities (''Admin > Plugins > Web services > API Documentation'').

	==Enabling capabilities==		==Enabling capabilities==

Jmouneyrac: /* Adding functions to the service */

2011-11-02T02:02:07Z

Adding functions to the service

← Older revision		Revision as of 02:02, 2 November 2011
Line 33:		Line 33:

	==Adding functions to the service==		==Adding functions to the service==
	[[Image:Select a web service function.jpg\|thumb\|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For ~~now~~, select 'Create group' ~~as it is the function used as an example in [[Development:Creating_a_web_service_client\|Creating a web service client]]~~.		[[Image:Select a web service function.jpg\|thumb\|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For this example, select 'Create group'.

	# Click 'Add functions' link		# Click 'Add functions' link
	# Select 'create group' function and click the 'Add functions' button		# Select 'create group' function and click the 'Add functions' button

	You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the ~~web service~~ function ~~documentation for details~~.		You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the function descriptions in the API Documenation (''Admin > Plugins > Web services > API Documentation'').

	==Enabling capabilities==		==Enabling capabilities==

Jmouneyrac: /* Alternative settings */

2011-11-02T01:58:21Z

Alternative settings

← Older revision		Revision as of 01:58, 2 November 2011
Line 59:		Line 59:
	# Select some users and click '''Add'''		# Select some users and click '''Add'''

	Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: IP restriction and Valid until.		Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: ''IP restriction'' and ''Valid until''.

	== Create a token ==		== Create a token ==
Line 71:		Line 71:

	As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.		As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.
			Finally, you can note that like for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.

Jmouneyrac: /* Enabling capabilities */

2011-11-02T01:55:54Z

Enabling capabilities

← Older revision		Revision as of 01:55, 2 November 2011
Line 46:		Line 46:
	* [[Capabilities/moodle/webservice:createtoken\|moodle/webservice:createtoken]] - for allowing users to generate a security key		* [[Capabilities/moodle/webservice:createtoken\|moodle/webservice:createtoken]] - for allowing users to generate a security key
	* [[Capabilities/webservice/rest:use \| webservice/rest:use]], [[Capabilities/webservice/soap:use \| webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use \| webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use \| webservice/amf:use]] which match the enabled protocols.		* [[Capabilities/webservice/rest:use \| webservice/rest:use]], [[Capabilities/webservice/soap:use \| webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use \| webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use \| webservice/amf:use]] which match the enabled protocols.
	* The service ''Required capability'' if set (Manage ~~Services~~ >'''Edit''' link).		* The service ''Required capability'' if set (''Site administration > Plugins > Web services > Manage services >'''Edit''' link'').
	* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.		* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.

Jmouneyrac: /* Enabling capabilities */

2011-11-02T01:55:01Z

Enabling capabilities

← Older revision		Revision as of 01:55, 2 November 2011
Line 46:		Line 46:
	* [[Capabilities/moodle/webservice:createtoken\|moodle/webservice:createtoken]] - for allowing users to generate a security key		* [[Capabilities/moodle/webservice:createtoken\|moodle/webservice:createtoken]] - for allowing users to generate a security key
	* [[Capabilities/webservice/rest:use \| webservice/rest:use]], [[Capabilities/webservice/soap:use \| webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use \| webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use \| webservice/amf:use]] which match the enabled protocols.		* [[Capabilities/webservice/rest:use \| webservice/rest:use]], [[Capabilities/webservice/soap:use \| webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use \| webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use \| webservice/amf:use]] which match the enabled protocols.
			* The service ''Required capability'' if set (Manage Services >'''Edit''' link).
	* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.		* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.

Jmouneyrac: /* Enabling capabilities */

2011-11-02T01:52:26Z

Enabling capabilities

← Older revision		Revision as of 01:52, 2 November 2011
Line 46:		Line 46:
	* [[Capabilities/moodle/webservice:createtoken\|moodle/webservice:createtoken]] - for allowing users to generate a security key		* [[Capabilities/moodle/webservice:createtoken\|moodle/webservice:createtoken]] - for allowing users to generate a security key
	* [[Capabilities/webservice/rest:use \| webservice/rest:use]], [[Capabilities/webservice/soap:use \| webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use \| webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use \| webservice/amf:use]] which match the enabled protocols.		* [[Capabilities/webservice/rest:use \| webservice/rest:use]], [[Capabilities/webservice/soap:use \| webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use \| webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use \| webservice/amf:use]] which match the enabled protocols.
	* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service.		* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.

	Once done, the web service should be set up. Users ~~can~~ [[How_to_get_a_security_key\|obtain a personal security key]] ~~and copy it in an external application~~.		Once done, the web service should be set up. Users should be able to [[How_to_get_a_security_key\|obtain a personal security key]].

	= Alternative settings =		= Alternative settings =

Jmouneyrac: /* Alternative settings */

2011-11-02T01:51:31Z

Alternative settings

← Older revision		Revision as of 01:51, 2 November 2011
Line 69:		Line 69:
	# Click on '''Saves changes'''		# Click on '''Saves changes'''

	~~== Enable capabilities for the user==~~		As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.
	~~The last step, and the trickiest, is to grant the right permission to the external system user. It would need the following capabilities:~~
	* "''webservice/rest:use'', ''webservice/soap:use'', ''webservice/xmlrpc:use'', ''webservice/amf:use''" matching the enabled protocols.
	* the required capabilities by the web service functions. These required capabilities are listed when you add a function to the service.
	As you ~~previously~~ created a token for ~~the external system~~ user, you do not need to assign "''moodle/webservice:createtoken''" to ~~it.~~
	~~For more information about roles and capabilities, read the [https://docs.moodle.org/en~~/~~Manage_roles Manage roles] documentation~~.

← Older revision		Revision as of 08:42, 24 November 2011
Line 72:		Line 72:
	As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.		As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.
	Finally, note that, as for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.		Finally, note that, as for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.

			== See also ==

			*[http://www.joomdle.com/wiki/Preparing_Moodle_20#Setting_up_Moodle_Web_services Joomdle documentation about setting Moodle web services]