Using web services - Revision history

Harrysmith: /* Enabling protocols */

2017-03-16T10:24:46Z

Enabling protocols

← Older revision		Revision as of 10:24, 16 March 2017
Line 10:		Line 10:

	== Enabling protocols ==		== Enabling protocols ==
	[[Image:Enable_protocol.jpg\|thumb\|Enabling protocols]]		[[Image:Enable_protocol.jpg\|thumb\|left\|Enabling protocols]]
	Usually external applications that users wish to use dictate which protocols should be enabled.		Usually external applications that users wish to use dictate which protocols should be enabled.

Harrysmith: /* Enabling protocols */

2017-03-16T10:23:48Z

Enabling protocols

← Older revision		Revision as of 10:23, 16 March 2017
Line 10:		Line 10:

	== Enabling protocols ==		== Enabling protocols ==
	[[Image:Enable_protocol.jpg\|thumb~~\|left~~\|Enabling protocols]]		[[Image:Enable_protocol.jpg\|thumb\|Enabling protocols]]
	Usually external applications that users wish to use dictate which protocols should be enabled.		Usually external applications that users wish to use dictate which protocols should be enabled.

Dmonllao at 02:36, 7 May 2015

2015-05-07T02:36:20Z

← Older revision		Revision as of 02:36, 7 May 2015
Line 38:		Line 38:
	# Select 'create group' function and click the 'Add functions' button		# Select 'create group' function and click the 'Add functions' button

	''Note that~~, from Moodle 2.9,~~ deprecated functions can not be added to services although ~~deprecated functions~~ that are already part of a service can remain there until they are removed from Moodle codebase.''		''Note that deprecated functions can not be added to services although the ones that are already part of a service can remain there until they are removed from Moodle codebase.''

	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 (''Administration > Site administration > 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 (''Administration > Site administration > Plugins > Web services > API Documentation'').

Dmonllao: /* Adding functions to the service */

2015-05-07T02:34:45Z

Adding functions to the service

← Older revision		Revision as of 02:34, 7 May 2015
Line 37:		Line 37:
	# 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

			''Note that, from Moodle 2.9, deprecated functions can not be added to services although deprecated functions that are already part of a service can remain there until they are removed from Moodle codebase.''

	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 (''Administration > Site administration > 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 (''Administration > Site administration > Plugins > Web services > API Documentation'').

Hig: Update the old block name "Settings" to "Administration"

2015-03-29T09:41:58Z

Update the old block name "Settings" to "Administration"

Tsala: Reverted edits by Rafael1973 (talk) to last revision by Tsala

2012-03-13T07:18:37Z

Reverted edits by Rafael1973 (talk) to last revision by Helen Foster

← Older revision		Revision as of 07:18, 13 March 2012
Line 5:		Line 5:
	[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]		[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]
	# Access ''Settings > Site administration > Advanced features''		# Access ''Settings > Site administration > Advanced features''
	# Check 'Enable web services' then click 'Save Changes'~~rafael.virtual.es~~		# Check 'Enable web services' then click 'Save Changes'

	Note: For security reasons, web services should only be enabled if you intend to make use of it.		Note: For security reasons, web services should only be enabled if you intend to make use of it.
	~~rafael.virtual.es~~

	== Enabling protocols ==		== Enabling protocols ==

Rafael1973: /* Enabling web services */ rafael.virtual.es

2012-03-12T15:40:44Z

Enabling web services: rafael.virtual.es

← Older revision		Revision as of 15:40, 12 March 2012
Line 5:		Line 5:
	[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]		[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]
	# Access ''Settings > Site administration > Advanced features''		# Access ''Settings > Site administration > Advanced features''
	# Check 'Enable web services' then click 'Save Changes'		# Check 'Enable web services' then click 'Save Changes'rafael.virtual.es

	Note: For security reasons, web services should only be enabled if you intend to make use of it.		Note: For security reasons, web services should only be enabled if you intend to make use of it.
			rafael.virtual.es

	== Enabling protocols ==		== Enabling protocols ==

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.

← Older revision		Revision as of 09:41, 29 March 2015
Line 4:		Line 4:
	== Enabling web services==		== Enabling web services==
	[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]		[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]
	# Access ''~~Settings~~ > Site administration > Advanced features''		# Access ''Administration > Site administration > Advanced features''
	# Check 'Enable web services' then click 'Save Changes'		# Check 'Enable web services' then click 'Save Changes'

Line 13:		Line 13:
	Usually external applications that users wish to use dictate which protocols should be enabled.		Usually external applications that users wish to use dictate which protocols should be enabled.

	# Access ''~~Settings~~ > Site administration > Plugins > Web services > Manage protocols''		# Access ''Administration > Site administration > Plugins > Web services > Manage protocols''
	# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required		# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required

Line 25:		Line 25:
	You can enable only the specific functions that you need to expose, so not compromising on security.		You can enable only the specific functions that you need to expose, so not compromising on security.
	[[Image:Create a service.jpg\|thumb\|Creating a service\|left]]		[[Image:Create a service.jpg\|thumb\|Creating a service\|left]]
	# Access ''~~Settings~~ > Site administration > Plugins > Web services > External services''		# Access ''Administration > Site administration > Plugins > Web services > External services''
	# Click Add new custom service		# Click Add new custom service
	#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed		#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed
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 (''~~Settings~~ > Site administration > 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 (''Administration > 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 (''~~Settings~~ > Site administration > Plugins > Web services > Manage services >'''Edit''' link'').		* The service ''Required capability'' if set (''Administration > 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 [[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.

Line 55:		Line 55:
	== Authorise only specific users==		== Authorise only specific users==
	[[Image:Authorised users link.jpg\|thumb]] [[Image:Authorised user selection page.jpg\|thumb]]		[[Image:Authorised users link.jpg\|thumb]] [[Image:Authorised user selection page.jpg\|thumb]]
	# ''~~Settings~~ > Site Administration > Plugins > Web services > External Services''		# ''Administration > Site Administration > Plugins > Web services > External Services''
	# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)		# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)
	# Select some users and click '''Add'''		# Select some users and click '''Add'''
Line 65:		Line 65:
	This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.		This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.

	# ''~~Settings~~ > Site Administration > Plugins > Web services > Manage tokens''		# ''Administration > Site Administration > Plugins > Web services > Manage tokens''
	# Click on '''Add'''		# Click on '''Add'''
	# Select the created user and service		# Select the created user and service

← 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]