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

Mobile web services: Difference between revisions

From MoodleDocs
No edit summary
 
(20 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Mobile}}
{{Web services}}
{{Moodle 2.1}}Moodle 2.1 comes with a built-in web service designed for mobile applications. It is required to run the official [[Mobile app]]. Enable it only if you want people to use the official app or if a third party app explicitly requires it.
Moodle comes with a built-in web service designed for mobile applications. It is required to run the official [[Mobile app]]. Enable it only if you want people to use the official app or if a third party app explicitly requires it.


== Enabling mobile web services ==
== Enabling mobile web services ==
Line 6: Line 6:
A site administrator first must enable mobile web services:
A site administrator first must enable mobile web services:


*In ''Settings > Site administration > Plugins > Web services > External services''  
*In ''Administration > Site administration > Mobile app > Mobile settings''  
*Check "Enable mobile web services" and then
*Check "Enable web services for mobile devices" and then
*Click Save.
*Click Save.


That's it! No other steps required.
That's it! No other steps required.


== What happens after enabled ==
The rest of this document explains the "behind the scenes".
 
== What happens when the service is enabled ==
Enabling the mobile web services will automatically:
Enabling the mobile web services will automatically:
* enable the web services system (''Settings > Site administration > Advanced features'')
* enable the web services system (''Administration > Site administration > Advanced features'')
* enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled
* enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled
* enable the xml-rpc protocol
* enable the xml-rpc protocol (for backward compatibility with unmaintained My Moodle app)
* enable the rest protocol
* allow the 'webservice/xmlrpc:use' capability for authenticated user role
* allow the 'webservice/xmlrpc:use' capability for authenticated user role
 
* allow the 'webservice/rest:use' capability for authenticated user role
The rest of this document explains "behind the scenes" for any further mobile service customization.


== Disabling mobile web services ==
== Disabling mobile web services ==
Line 27: Line 29:
** disable the web services system
** disable the web services system
** disable the xml-rpc protocol
** disable the xml-rpc protocol
** disable the rest protocol
** remove the 'webservice/xmlrpc:use' capability for authenticated user role
** remove the 'webservice/xmlrpc:use' capability for authenticated user role
** remove the 'webservice/rest:use' capability for authenticated user role


==See also==
==See also==
*[[How to enable web services for ordinary users]]
* [[Mobile app]]


[[Category:Web Services]]
[[Category:Mobile]]
[[Category:Mobile]]
[[de:Mobile Webservices]]
[[ja:モバイルウェブサービス]]
[[es:Servicios web para móviles]]
[[fr:Services Web mobile]]

Latest revision as of 12:52, 17 May 2019

Moodle comes with a built-in web service designed for mobile applications. It is required to run the official Mobile app. Enable it only if you want people to use the official app or if a third party app explicitly requires it.

Enabling mobile web services

A site administrator first must enable mobile web services:

  • In Administration > Site administration > Mobile app > Mobile settings
  • Check "Enable web services for mobile devices" and then
  • Click Save.

That's it! No other steps required.

The rest of this document explains the "behind the scenes".

What happens when the service is enabled

Enabling the mobile web services will automatically:

  • enable the web services system (Administration > Site administration > Advanced features)
  • enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled
  • enable the xml-rpc protocol (for backward compatibility with unmaintained My Moodle app)
  • enable the rest protocol
  • allow the 'webservice/xmlrpc:use' capability for authenticated user role
  • allow the 'webservice/rest:use' capability for authenticated user role

Disabling mobile web services

When you uncheck 'Enable mobile web services', it will automatically:

  • disable the external service called 'Mobile web services'.
  • if 'Mobile web services' was the only external service enabled:
    • disable the web services system
    • disable the xml-rpc protocol
    • disable the rest protocol
    • remove the 'webservice/xmlrpc:use' capability for authenticated user role
    • remove the 'webservice/rest:use' capability for authenticated user role

See also