Web services FAQ: Difference between revisions
| Line 18: | Line 18: | ||
Since different Moodle sites can extend or restrict the API, and the API will evolve over time, the best way to see the exact API for a particular Moodle site is to look at the automatically generated documentation. | Since different Moodle sites can extend or restrict the API, and the API will evolve over time, the best way to see the exact API for a particular Moodle site is to look at the automatically generated documentation. | ||
# enable web service | # enable web service, create a service and add all existing Moodle functions to it. You can get help from this [https://docs.moodle.org/en/How_to_enable_web_services_for_ordinary_users guide]. | ||
# connect as non admin, and access the service documentation on your [https://docs.moodle.org/en/How_to_get_a_security_key security page]. | |||
# | # for security purpose, you can delete the created service now. | ||
== Why are there not many functions in the API? == | == Why are there not many functions in the API? == | ||
Revision as of 06:08, 24 November 2010
This document lists some popular questions from the Web Services forum.
What is the difference between web services and Mnet
- Mnet is used to authenticate some users from a Moodle A site into a Moodle B site.
- Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).
I see the term "Web services" used in different ways, what does it mean?
- The entire system in Moodle is referred to as the Moodle Web Service system.
- A particular action (like creating a user) is known as a Web service function.
- The admin can enable groups of these functions for outside use, and these are known as a "Web service".
Where is the Web Service API documented?
Since different Moodle sites can extend or restrict the API, and the API will evolve over time, the best way to see the exact API for a particular Moodle site is to look at the automatically generated documentation.
- enable web service, create a service and add all existing Moodle functions to it. You can get help from this guide.
- connect as non admin, and access the service documentation on your security page.
- for security purpose, you can delete the created service now.
Why are there not many functions in the API?
We have been very careful when adding new functions because we don't want to be changing the API functions once they are implemented. The ones we have in Moodle 2.0 are the most commonly requested ones (for users, courses, groups and enrolments).
We will add more functions to core over time, based on contributions from the community and feature requests. See the Moodle tracker for a rough roadmap of future web services. Please contribute with suggestions, votes and code!
You can also extend the API on your own Moodle site by creating your own API functions (see next question).
How can I create a new web service function?
The easiest and recommended way to add a web service is to write a new Moodle local plugin and to implement the web service functions there. The Moodle administrator will just need to add the plugin in Moodle (copy the files in /local/), the web service functions will be automatically added. Please read /local/readme.txt for more information about plugin development. You can also look at the Moodle Hub server plugin as an example.
How can I set up a web service?
- See the documents in the web service category.
- In Moodle > Site administration > plugins > Web services > Overview, two use cases are described.
- Finally you can go ask question on the Web Services forum
