Development:Web services: Difference between revisions

Latest revision as of 09:50, 4 February 2010

Introduction

This page described the Web Services module implemented for Moodle 2.0
The official discussion forum is here
The tracker issues are here: MDL-12886 and MDL-17135
This module is been implemented by Moodle HQ and DFWS Team.

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 would work but it will not be the unique way to access web services. Please have a look to the Development: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).
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.

Web description format

All functions that can be called via web services can be declared in a db/service.php file and can be defined in an externallib.php file somewhere. The description of the functions that can be called, and what parameters they require, are explained in the External Service description document.

Web services technical documentation

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

Authentication

Please have a look to the Development:External services security page

@@ Line 1: / Line 1: @@
-{{Template:Work in progress}}{{Moodle_2.0}}
+{{Moodle_2.0}}
-=Introduction=
+==Introduction==
 This page described the Web Services module implemented for Moodle 2.0<br>
-The tracker issue is here: MDL-12886<br>
+The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br>
-This module is been implemented by the Web Service Team: [http://blogs.dfwikilabs.org/moodle_ws/ Moodle Web Service Team]
+The tracker issues are here: MDL-12886 and MDL-17135<br>
+This module is been implemented by Moodle HQ and [http://blogs.dfwikilabs.org/moodle_ws/ DFWS Team].
-=Implementation=
+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.
-Web Services module has been conceived in a purpose to be ported on different Moodle version, and also on different project. It has also for purpose to support multiple web service protocols (REST, SOAP, AMFPHP, ...). Adding a new protocol support should be relatively easy.
-== How does it work ==
+== How it works ==
-The web service client call a Moodle web service. The web service is located in a folder specific to the used protocol. It's usually a inout.php file. This file runs the web service server and gets the sent parameters. Then it calls a wrapper. The wrapper.php file is implemented in order to call the Moodle API which contains all callable functions. The wrapper will check a "generated file" in order to know which functions are available, and what their parameters and what they returned.<br>
+This following example would work but it will not be the unique way to access web services. Please have a look to the [[Development:External services security]] page for more details.
-For any protocol there should be at least one inout.php file and one wrapper file.
+#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).
+#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.
-=Security=
+==Web description format==
-How does the web services are secured ?<br>
-Security layer implemented by every protocol?
+All functions that can be called via web services can be declared in a db/service.php file and can be defined in an externallib.php file somewhere. The description of the functions that can be called, and what parameters they require, are explained in the [https://docs.moodle.org/en/Development:Web_services_description External Service description document].
-=List of functions=
-All callable functions are declared into Moodle API, please read [https://docs.moodle.org/en/index.php?title=Development:Moodle_API Moodle API documentation].
+==Web services technical documentation==
+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
+''
+==Authentication==
+Please have a look to the [[Development:External services security]] page
+==See also==
+* [[Development:External services security]]
+* [[Development:External services description]]
+* [[Development:Creating_a_web_service_and_a_web_service_function]]
+* [[Development:Creating a web service client]]
+* [[Web_Services]]
+[[Category:Web Services]]

Documentation