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

Difference between revisions of "Web services FAQ"

From MoodleDocs
(changes copied from 2.0 wiki)
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, 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].
+
'''Full API documentation'''
# connect as non admin, and access the service documentation on your [https://docs.moodle.org/en/How_to_get_a_security_key security page].
+
# Connect as admin
# for security purpose, you can delete the created service now.
+
# Go to Administration Settings block > Plugins > Web services > API documentation
 +
 
 +
'''Specific documentation to a user'''
 +
# Connect as admin, enable web service, create a service and add some Moodle functions to it. Also see [[How_to_create_and_enable_a_web_service]].
 +
# connect as non admin, and access the service documentation on your [[How_to_get_a_security_key|security keys page]].
  
 
== Why are there not many functions in the API? ==
 
== Why are there not many functions in the API? ==
Line 26: Line 30:
 
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 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 [https://docs.moodle.org/dev/Web_services_Roadmap a roadmap of future web services]. Please contribute with suggestions, votes and code!
+
We will add more functions to core over time, based on contributions from the community and feature requests.  See the [[:dev:Web_services_Roadmap|web service roadmap]].
  
 
You can also extend the API on your own Moodle site by creating your own API functions (see next question).
 
You can also extend the API on your own Moodle site by creating your own API functions (see next question).
Line 32: Line 36:
 
== How can I create a new web service function? ==
 
== 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 [http://moodle.org/mod/data/view.php?d=13&rid=4282 Moodle Hub server plugin] as an example.
+
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. Finally read  [[:dev:Creating_a_web_service_and_a_web_service_function|how to implement a web service and a web service function]].
  
 
== How can I set up a web service? ==
 
== How can I set up a web service? ==
  
* See the documents in the [[:Category:Web Services]].  
+
* See the document [[How_to_create_and_enable_a_web_service| How to create and enable a web service]].  
* In ''Settings > Site administration > Plugins > Web services > Overview'' two use cases are described.
+
* ''Settings > Site administration > Plugins > Web services > Overview'' explains two use cases.
* Finally you can go ask question on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]
+
* Finally ask questions on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]
  
 
== Does the Moodle SOAP server work with JAVA or .NET? ==
 
== Does the Moodle SOAP server work with JAVA or .NET? ==
  
Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-20804 for plans to create a JAVA-compatible SOAP WSDL and JAVA client.
+
Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-28988 and MDL-28989 for plans to create a JAVA-compatible SOAP WSDL.
  
 
==See also==
 
==See also==

Revision as of 12:49, 9 November 2011

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?

  1. The entire system in Moodle is referred to as the Moodle Web Service system.
  2. A particular action (like creating a user) is known as a Web service function.
  3. 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.

Full API documentation

  1. Connect as admin
  2. Go to Administration Settings block > Plugins > Web services > API documentation

Specific documentation to a user

  1. Connect as admin, enable web service, create a service and add some Moodle functions to it. Also see How_to_create_and_enable_a_web_service.
  2. connect as non admin, and access the service documentation on your security keys page.

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 web service roadmap.

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. Finally read how to implement a web service and a web service function.

How can I set up a web service?

Does the Moodle SOAP server work with JAVA or .NET?

Unfortunately the generated WSDL isn't currently compatible with JAVA or .NET. See MDL-28988 and MDL-28989 for plans to create a JAVA-compatible SOAP WSDL.

See also