Web services: Difference between revisions
From MoodleDocs
Line 15: | Line 15: | ||
The full API can be found on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''. | The full API can be found on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''. | ||
* [[Web services API]] and [[External functions API]] | |||
* [[Creating a web service and a web service function | Implement a web service and a web service function]] | * [[Creating a web service and a web service function | Implement a web service and a web service function]] | ||
* [[Creating a web service client | Implement a web service client]] | * [[Creating a web service client | Implement a web service client]] |
Revision as of 03:09, 17 January 2012
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.
Developer documentation
The full API can be found on any Moodle sites under Administration block > Plugins > Web services > API Documentation.
- Web services API and External functions API
- Implement a web service and a web service function
- Implement a web service client
- Web services files handling
- Web service Roadmap