Note: You are currently viewing documentation for Moodle 2.3. Up-to-date documentation for the latest stable version is available here: Web services.

Web services: Difference between revisions

From MoodleDocs
Main page ► Managing a Moodle site ► Web services
Managing a Moodle site
No edit summary
(→‎See also: wording added from 2.0 wiki)
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Managing a Moodle site}}
{{Managing a Moodle site}}
Web services enable other systems to login to Moodle and perform operations.  
Web services enable other systems to login to Moodle and perform operations.  
=== 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 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.


== Administrator documentation ==
== Administrator documentation ==
Line 22: Line 9:
Most of the time, the client application will retrieve the key (token) for a user. However, it is still possible for a user to view the key and to regenerate it.
Most of the time, the client application will retrieve the key (token) for a user. However, it is still possible for a user to view the key and to regenerate it.
* [[Security keys|How to obtain a security key (token)]]
* [[Security keys|How to obtain a security key (token)]]
== Developer documentation==
The full API can be founnd on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.
* [[Development:Creating a web service and a web service function | Implement a web service and a web service function]]
* [[Development:Creating a web service client | Implement a web service client]]
* [https://docs.moodle.org/dev/Web_services_Roadmap Web service Roadmap]


==See also==
==See also==
Line 35: Line 15:
* [[Web_services_FAQ|Web services FAQ]]
* [[Web_services_FAQ|Web services FAQ]]


Specification / core development:
Developer documentation:
* [[Development:External services security]]
* [[Development:Web_services | Web services developer documentation]]
* [[Development:External services description]]
* [[:dev:Web_services_Roadmap | Web service Roadmap]]


Other implementations:
Other implementations:

Latest revision as of 12:48, 9 November 2011

Web services enable other systems to login to Moodle and perform operations.

Administrator documentation

User documentation

Most of the time, the client application will retrieve the key (token) for a user. However, it is still possible for a user to view the key and to regenerate it.

See also

Sharing knowledge:

Developer documentation:

Other implementations:

Retrieved from "https://docs.moodle.org/23/en/index.php?title=Web_services&oldid=93573"
Powered by MediaWiki