Web services: Difference between revisions

Revision as of 21:31, 2 April 2020

How it works

This simple example will give you an idea of how our web services infrastructure works.

The client sends a username and password to the web service login script.
The script returns a token for that user account.
The client calls a particular web service function on a protocol server including the token .
The protocol server uses the token to check that the user can call the function.
The protocol server calls the matching external function, located in a externallib.php file inside the relevant module.
The external function checks that the current user has_capability to do this operation.
The external function calls the matching Moodle core function (in lib.php usually).
The core function can return a result to the external function.
The external function will return a result to the protocol server.
The protocol server returns the result to the client.

Developer documentation

The full API can be found on any Moodle sites under Administration block > Plugins > Web services > API Documentation.

Note: Additional services are available for uploading and downloading files which are not in the API Documentation - they are accessed in a different way. See Web services files handling

@@ Line 1: / Line 1: @@
-{{Moodle_2.0}}
+=== How it works ===
+This simple example will give you an idea of how our web services infrastructure works.
-=Introduction=
+#The client sends a username and password to the web service login script.
-This page described the Web Services module implemented for Moodle 2.0<br>
+#The script returns a token for that user account.
-The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br>
+#The client calls a particular web service function on a protocol server including the token .
-The tracker issue is here: MDL-12886<br>
+#The protocol server uses the token to check that the user can call the function.
-This module is been implemented by Moodle HQ and [http://blogs.dfwikilabs.org/moodle_ws/ DFWS Team].
+#The protocol server calls the matching external function, located in a externallib.php file inside the relevant module.
-=Implementation=
-The Web Services module has been conceived in order to be ported to different Moodle versions and for different projects. The objective is to support multiple web service protocols (REST, SOAP, XML-RPC and AMF). Adding support for a new protocol should be relatively easy.
-== How it works ==
-This following example works but it will not be the unique way to access web services. Please have a look to the [[External services security]] page for more details.
-#The client sends a username and password to the web service protocol server script.
-#The protocol server returns a session token for that user account (how this is sent depends on the protocol).
-#The client calls a particular web service function including the session token.
-#The protocol server uses the token to check that the web service session is still active.
-#The protocol server call the matching external function, located in a externallib.php file inside the relevant module.
 #The external function checks that the current user has_capability to do this operation.
 #The external function calls the matching Moodle core function (in lib.php usually).
@@ Line 23: / Line 12: @@
 #The protocol server returns the result to the client.
-==Web description format==
+== Developer documentation==
+The full API can be found on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.
-All functions that can be called via web services can be declared in an externallib.php file somewhere. The description of the functions that can be called, and what parameters they require, is defined in the [https://docs.moodle.org/en/Development:Web_services_description|Web Service description page].
+'''Note:''' Additional services are available for uploading and downloading files which are not in the API Documentation - they are accessed in a different way. See [[Web services files handling]]
-==Web services technical documentation==
+* [[How to contribute a web service function to core]]
-In order to facilitate a Moodle web service client implementation, every Moodle sites will provide a page listing all function descriptions. This page also gives some useful advice for any supported protocol. To call this page: ''your_moodle/webservice/wsdoc.php?protocol=soap
+* [[Adding a web service to a plugin| Adding a web service to your plugin]]
-''
+* [[Creating a web service client | Implement a web service client]]
+* [[Web services files handling]]
+* [[Web_services_Roadmap | Web service Listing & Roadmap]]
-==API - Function list==
+== Specification and brainstorming ==
-The web service functions are [[Web_services_API_-_Function_List|listed here]]. (obsolete)
+* [[External services security | External services security]]
+* [[External services description | External services description]]
-=Authentication=
+== See also ==
-Please have a look to the [[External services security]] page
+* [[Web_service_API_functions|Web service API functions]]
-=See also=
+* [[:en:Web_services_FAQ|Web services FAQ]]
-* [[External services security]]
+* [[:en:How_to_create_and_enable_a_web_service|How to create and enable a web service]]
-* [[External services description]]
+* [[:en:Enable mobile web services|How to enable the mobile web service]]
+* [[:en:Web_services|Web services user documentation]]
+* [http://www.slideshare.net/juanleyva/mastering-moodle-web-services-development Mastering Moodle Web Services development] - Last session of the Hackfest in the MoodleMoot UK 2016
-[[Category:Web Services]]
+[[Category:Web_Services]]