Using web services - Revision history

Joelpeltonen: Improve source readability, remove floats to improve rendered legibility

2025-05-13T10:23:51Z

Improve source readability, remove floats to improve rendered legibility

Tsala: /* Enabling capabilities */

2025-05-08T08:43:38Z

Enabling capabilities

← Older revision		Revision as of 08:43, 8 May 2025
Line 37:		Line 37:
	The final step is to grant appropriate permissions. The following capabilities should be allowed:		The final step is to grant appropriate permissions. The following capabilities should be allowed:
	* [[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/amf:use\|webservice/amf:use]] which match the enabled protocols.
	* The service ''Required capability'' if set (''Administration > Site administration > Server > Web services > Manage services >'''Edit''' link'').		* The service ''Required capability'' if set (''Administration > Site administration > Server > 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.

Tsala: /* Enabling protocols */

2025-05-08T08:43:18Z

Enabling protocols

← Older revision		Revision as of 08:43, 8 May 2025
Line 10:		Line 10:
	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 ''Administration > Site administration > Server > Web services > Manage protocols''		# Access ''Administration > Site administration > Server > Web services > Manage protocols''
	# Enable the protocols (SOAP, REST~~, XMLRPC~~, AMF, ...) as required		# Enable the protocols (SOAP, REST, AMF, ...) as required

	== Enabling web service function documentation ==		== Enabling web service function documentation ==

Marycooch: Reverted edits by Marycooch (talk) to last revision by Rwthornton

2024-05-01T10:36:26Z

Reverted edits by Marycooch (talk) to last revision by Randy Thornton

← Older revision		Revision as of 10:36, 1 May 2024
Line 4:		Line 4:
	[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]		[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]
	# Access ''Administration > Site administration > Advanced features''		# Access ''Administration > Site administration > Advanced features''
	# Check 'Enable web services ~~for mobile devices~~' then click 'Save Changes'		# 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.

	== Enabling protocols ==		== Enabling protocols ==
	[[Image:Enable_protocol.jpg\|thumb\|left\|Enabling protocols]]		[[Image:Enable_protocol.jpg\|thumb\|left\|Enabling protocols]]

Marycooch: /* Enabling web services */

2024-05-01T10:17:33Z

Enabling web services

← Older revision		Revision as of 10:17, 1 May 2024
Line 4:		Line 4:
	[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]		[[Image:Enable_web_service.jpg\|thumb\|Enabling web services]]
	# Access ''Administration > Site administration > Advanced features''		# Access ''Administration > Site administration > Advanced features''
	# Check 'Enable web services' then click 'Save Changes'		# Check 'Enable web services for mobile devices' 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.

	== Enabling protocols ==		== Enabling protocols ==
	[[Image:Enable_protocol.jpg\|thumb\|left\|Enabling protocols]]		[[Image:Enable_protocol.jpg\|thumb\|left\|Enabling protocols]]

Rwthornton: /* Adding functions to the service */

2021-10-22T15:24:48Z

Adding functions to the service

← Older revision		Revision as of 15:24, 22 October 2021
Line 32:		Line 32:
	''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.''		''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 > Server > Web services > API Documentation'').

	==Enabling capabilities==		==Enabling capabilities==
	The final step is to grant appropriate permissions. The following capabilities should be allowed:		The final step is to grant appropriate permissions. The following capabilities should be allowed:

Rwthornton: /* Create a token */

2021-10-22T15:24:32Z

Create a token

← Older revision		Revision as of 15:24, 22 October 2021
Line 52:		Line 52:
	[[Image:Create_token.jpg\|thumb]]		[[Image:Create_token.jpg\|thumb]]
	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.
	# ''Administration > Site Administration > ~~Plugins~~ > Web services > Manage tokens''		# ''Administration > Site Administration > Server > Web services > Manage tokens''
	# Click on '''Add'''		# Click on '''Add'''
	# Select the created user and service		# Select the created user and service
Line 58:		Line 58:
	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 ==		== See also ==
	*[http://www.joomdle.com/wiki/Preparing_Moodle_20#Setting_up_Moodle_Web_services Joomdle documentation about setting Moodle web services]		*[http://www.joomdle.com/wiki/Preparing_Moodle_20#Setting_up_Moodle_Web_services Joomdle documentation about setting Moodle web services]

Rwthornton: /* Authorise only specific users */

2021-10-22T15:24:18Z

Authorise only specific users

← Older revision		Revision as of 15:24, 22 October 2021
Line 44:		Line 44:
	== 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]]
	# ''Administration > Site Administration > ~~Plugins~~ > Web services > External Services''		# ''Administration > Site Administration > Server > 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'''
	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''.		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 ==
	[[Image:Create_token.jpg\|thumb]]		[[Image:Create_token.jpg\|thumb]]

Rwthornton: /* Enabling capabilities */

2021-10-22T15:23:09Z

Enabling capabilities

← Older revision		Revision as of 15:23, 22 October 2021
Line 37:		Line 37:
	* [[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 (''Administration > Site administration > ~~Plugins~~ > Web services > Manage services >'''Edit''' link'').		* The service ''Required capability'' if set (''Administration > Site administration > Server > 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.
	Once done, the web service should be set up. Users should be able to [[Security keys\|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 =
	== Authorise only specific users==		== Authorise only specific users==

Rwthornton: /* Enabling protocols */

2021-10-22T15:21:18Z

Enabling protocols

← Older revision		Revision as of 15:21, 22 October 2021
Line 9:		Line 9:
	[[Image:Enable_protocol.jpg\|thumb\|left\|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.
	# Access ''Administration > Site administration > ~~Plugins~~ > Web services > Manage protocols''		# Access ''Administration > Site administration > Server > Web services > Manage protocols''
	# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required		# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required

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