Note: You are currently viewing documentation for Moodle 3.9. Up-to-date documentation for the latest stable version of Moodle may be available here: Using web services.

Using web services: Difference between revisions

From MoodleDocs
No edit summary
(ja link)
(24 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Web services}}
{{Web services}}
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service. Each user will normally enter their own security key into an external application.
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.


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


== 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 ==
There are no default web services in Moodle so it is necessary to create a custom service i.e. select which of the standard web service functions are available via that service.
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.


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 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.
''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'').


==Enabling capabilities==
==Enabling capabilities==
Line 46: Line 48:
* [[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 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.


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 [[Security keys|obtain a personal security key]].


= Alternative settings =  
= Alternative settings =  
Line 54: Line 57:
== 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
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)
# Select the created user and click '''Add'''
# Select some users and click '''Add'''


As you can see in the second screen capture, Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user 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 64: Line 67:
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
# 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:
Finally, note that, as for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.
* "''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.
== See also ==
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.
*[http://www.joomdle.com/wiki/Preparing_Moodle_20#Setting_up_Moodle_Web_services Joomdle documentation about setting Moodle web services]
 
[[de:Webservices nutzen]]
[[fr:Utilisation des services Web]]
[[ja:ウェブサービスを使用する]]

Revision as of 13:49, 25 April 2020

This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.

Enabling web services

Enabling web services
  1. Access Administration > Site administration > Advanced features
  2. 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.

Enabling protocols

Enabling protocols

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

  1. Access Administration > Site administration > Plugins > Web services > Manage protocols
  2. Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required

Enabling web service function documentation

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

If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.

You can enable only the specific functions that you need to expose, so not compromising on security.

Creating a service
  1. Access Administration > Site administration > Plugins > Web services > External services
  2. 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
    • 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)
  3. Enter a name and check Enabled
  4. Click the button 'Add service'

Adding functions to the service

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'.

  1. Click 'Add functions' link
  2. Select 'create group' function and click the 'Add functions' button

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).

Enabling capabilities

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

Once done, the web service should be set up. Users should be able to obtain a personal security key.

Alternative settings

Authorise only specific users

Authorised users link.jpg
Authorised user selection page.jpg
  1. Administration > Site Administration > Plugins > Web services > External Services
  2. Select Authorised users link (the service must have been set as Authorised users only in the Edit link)
  3. 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.

Create a token

Create token.jpg

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.

  1. Administration > Site Administration > Plugins > Web services > Manage tokens
  2. Click on Add
  3. Select the created user and service
  4. Click on Saves changes

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.

See also