Creating a web service client: Difference between revisions
From MoodleDocs
No edit summary |
|||
Line 13: | Line 13: | ||
Demo client sample codes can be downloaded on [https://github.com/moodlehq/sample-ws-clients Github]. | Demo client sample codes can be downloaded on [https://github.com/moodlehq/sample-ws-clients Github]. | ||
= How to get a user token = | |||
Your client can call the script located in /login/token.php with a simple HTTP request. We highly recommend to do it securely with HTTPS. | |||
The required parameters are: | |||
* username | |||
* password | |||
* service shortname - The service shortname is usually hardcoded in the pre-build service (db/service.php files). Moodle administrator will be able to edit shortnames for service created on the fly: MDL-29807 | |||
The script will return a json value: {token: string} or {error: string}. | |||
[[Category:Web Services]] | [[Category:Web Services]] |
Revision as of 09:32, 1 November 2011
Moodle 2.0
You need to have previously setup a web service. Read the Documentation for administrators.
To see the API Documentation, connect as Admin and go to Administration > Plugins > Web services > API Documentation
Officially supported protocols
- REST: the Moodle REST server uses POST for parameters and XML for returned values. This server is not RESTfull.
- SOAP: the Moodle SOAP server is based on the Zend SOAP server (itself based on the PHP SOAP server). Zend publishes a Zend SOAP client. The current server implementation doesn't work with Java/.Net because we didn't generated a fully describe WSDL yet. If you are working on a Java/.Net client, follow or participate to the tracker issues MDL-28988 / MDL-28989
- XML-RPC: the Moodle XML-RPC server is based on Zend XML-RPC server. Zend also publishes a Zend XML-RPC client.
- AMF: the Moodle AMF server is based on the Zend AMF server. The test client can be found in Settings blocks > Site Administration > Development > Web service test client > AMF Test client.
Demo client examples
Demo client sample codes can be downloaded on Github.
How to get a user token
Your client can call the script located in /login/token.php with a simple HTTP request. We highly recommend to do it securely with HTTPS. The required parameters are:
- username
- password
- service shortname - The service shortname is usually hardcoded in the pre-build service (db/service.php files). Moodle administrator will be able to edit shortnames for service created on the fly: MDL-29807
The script will return a json value: {token: string} or {error: string}.