https://docs.moodle.org/24/en/api.php?action=feedcontributions&feedformat=atom&user=JmouneyracMoodleDocs - User contributions [en]2026-05-30T09:03:54ZUser contributionsMediaWiki 1.43.5https://docs.moodle.org/24/en/index.php?title=Hub_administration&diff=103901Hub administration2013-04-08T10:04:49Z<p>Jmouneyrac: /* How to set up a Moodle Hub server */</p>
<hr />
<div>{{Community hubs}}<br />
==Deciding to run a Hub==<br />
<br />
Running a hub server is not something you should undertake lightly. <br />
<br />
As the hub administrator you are responsible for the content in the hub, and you need to put in place processes to:<br />
* verify all the course content is clean (of porn or malicious javascript)<br />
* manage registered sites and their status <br />
* maintain the quality of the listings through editing<br />
<br />
=== Minimal Requirements ===<br />
<br />
Below is a list of Minimal requirements for running a Moodle Community Hub.<br />
<br />
* MySQL - minimum version 5.0.25<br />
* PHP 5.3.2<br />
* Apache<br />
* ensure that the site you will be registering does not use any upper case letters (even though those are perfectly valid). ''EG: moodle.org/2012-Spring will not work!''<br />
* ensure that the following php.ini variables are set to "On"<br />
** allow_url_fopen: This setting is required the hub to be able to register a site. If this option is not enabled, you will be given the [[error/local_hub/cannotregisternotavailablesite|cannotregisternotavailablesite]] error. Related tracker issue: https://tracker.moodle.org/browse/CONTRIB-3063<br />
* mod_security in Apache version 1 and mod_security2 in Apache version 2 will return a 403 forbidden error when a URL that is not the local domain is passed as a get variable. mod_security on either the hub or client servers will block the completion of the client/hub registration process, even to MOOCH, as within the registration process URL's are passed as get variables a number of times. An exception can be added to mod_security in Apache version 1 via a local .htacess file. However, this ability was removed in mod_security2. In mod_security2 the exception must be added to mod_security.conf of /conf.d. Related forum discussion: http://moodle.org/mod/forum/discuss.php?d=188933<br />
<br />
==How the hub software works==<br />
<br />
The hub software is implemented as a separate "local" plugin designed to be added to a standard install of Moodle 2.0 or later. In this way the hub gets to use on all the features in the Moodle core API and benefits from maintenance of the core code.<br />
<br />
Once installed the whole site gets a new frontpage with a simple search box (see http://hub.moodle.org/ for example).<br />
<br />
Please don't add the hub capabilities to an existing Moodle site with real courses. Although it may work, there are some opportunities for GUI confusion and some unknowns when it comes to security, so please just avoid it. Moodle is free, so it's trivial to install another clean copy to build your hub with.<br />
<br />
==How to set up a Moodle Hub server==<br />
<br />
# Install Moodle 2.0 or later somewhere on a web server with a nice URL.<br />
# Download the latest hub plugin from https://github.com/moodlehq/moodle-local_hub<br />
# Save the zip into the /local directory of Moodle and unzip, producing /local/hub<br />
# Visit the "Notifications" page in Moodle (/admin) to complete the upgrade and install the hub software.<br />
# Uncheck password policy (search 'passwordpolicy' in admin search)<br />
# Allow extended characters in usernames (search 'extendedusernamechars' in admin search)<br />
# Enable web services for the hub (''Settings > Site Administration > Advanced features'')<br />
# Enable the XML-RPC protocol (''Settings > Site Administration > Plugins > Web services > Manage protocols'')<br />
# Set up the SMTP (''Settings > Site Administration > Plugins > Message outputs > Email'')<br />
# Set up the recaptcha (''Settings > Site Administration > Plugins > Authentication > Manage authentication'') <br />
# Set up your hub (''Settings > Site Administration > Hub > Settings'') Supply a description, enable the hub, supply a hub password.<br />
<br />
Congratulations! You now have a working hub with no content!<br />
<br />
==Site registration==<br />
<br />
Only sites that are registered with the hub are allowed to publish content there.<br />
<br />
Sites register on the hub via ''Settings > Site administration > Server > Hubs''.<br />
<br />
==Hub registration== <br />
<br />
You can also register your hub with the Moodle hub Directory, a listing of many hubs from around the world, enabling people from all over the world to find your hub and search the courses within it. You may want to wait until you have some content before you register.<br />
<br />
==Managing sites==<br />
In ''Settings > Site administration > Hub > Manage sites'', you can:<br />
* Prioritise a site: during a search, course from prioritised sites appear on top of the list. A prioritised site is always trusted.<br />
* Trust a site: when a site is trusted, any published course is immediately available<br />
* Delete a site: delete a site from the database. A message will be sent to the site administrator.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a site visible: only site declared as visible appear on the the site list (currently the site list hasn't been implemented)<br />
<br />
==Managing courses==<br />
In ''Settings > Site administration > Hub > Manage course'', you can:<br />
* Delete a course: delete a course from the database.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a course visible: decide if the course is displayed on search result<br />
<br />
== Important things about roles, users and web services ==<br />
A hub server uses intensively Moodle web service 2.0. For this reason it is important to understand the [https://docs.moodle.org/en/Web_Services web services administration], and what happens if you change some roles/users/services.<br />
<br />
=== Roles ===<br />
The hub server creates on the fly some roles that you should '''never delete/modify''':<br />
* one role for the hub directory<br />
* one role for registered sites<br />
* one role for public sites<br />
<br />
=== Users ===<br />
The hub server creates on the fly some users that you should '''never delete/modify''':<br />
* one user for the hub directory<br />
* one user for public access<br />
* as many users as registered sites<br />
<br />
=== Services ===<br />
The hub creates during installation some web services that you should '''never delete/modify''':<br />
* one service for Hub directory<br />
* one service for Registered sites<br />
* one service for Public sites<br />
<br />
It also creates tokens on the fly. These tokens are not displayed on the token management list, so you cannot accidentally delete them.<br />
<br />
==See also==<br />
<br />
*[[Site registration]]<br />
<br />
[[ja:ハブ管理]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Hub_administration&diff=103900Hub administration2013-04-08T10:03:16Z<p>Jmouneyrac: /* How to set up a Moodle Hub server */</p>
<hr />
<div>{{Community hubs}}<br />
==Deciding to run a Hub==<br />
<br />
Running a hub server is not something you should undertake lightly. <br />
<br />
As the hub administrator you are responsible for the content in the hub, and you need to put in place processes to:<br />
* verify all the course content is clean (of porn or malicious javascript)<br />
* manage registered sites and their status <br />
* maintain the quality of the listings through editing<br />
<br />
=== Minimal Requirements ===<br />
<br />
Below is a list of Minimal requirements for running a Moodle Community Hub.<br />
<br />
* MySQL - minimum version 5.0.25<br />
* PHP 5.3.2<br />
* Apache<br />
* ensure that the site you will be registering does not use any upper case letters (even though those are perfectly valid). ''EG: moodle.org/2012-Spring will not work!''<br />
* ensure that the following php.ini variables are set to "On"<br />
** allow_url_fopen: This setting is required the hub to be able to register a site. If this option is not enabled, you will be given the [[error/local_hub/cannotregisternotavailablesite|cannotregisternotavailablesite]] error. Related tracker issue: https://tracker.moodle.org/browse/CONTRIB-3063<br />
* mod_security in Apache version 1 and mod_security2 in Apache version 2 will return a 403 forbidden error when a URL that is not the local domain is passed as a get variable. mod_security on either the hub or client servers will block the completion of the client/hub registration process, even to MOOCH, as within the registration process URL's are passed as get variables a number of times. An exception can be added to mod_security in Apache version 1 via a local .htacess file. However, this ability was removed in mod_security2. In mod_security2 the exception must be added to mod_security.conf of /conf.d. Related forum discussion: http://moodle.org/mod/forum/discuss.php?d=188933<br />
<br />
==How the hub software works==<br />
<br />
The hub software is implemented as a separate "local" plugin designed to be added to a standard install of Moodle 2.0 or later. In this way the hub gets to use on all the features in the Moodle core API and benefits from maintenance of the core code.<br />
<br />
Once installed the whole site gets a new frontpage with a simple search box (see http://hub.moodle.org/ for example).<br />
<br />
Please don't add the hub capabilities to an existing Moodle site with real courses. Although it may work, there are some opportunities for GUI confusion and some unknowns when it comes to security, so please just avoid it. Moodle is free, so it's trivial to install another clean copy to build your hub with.<br />
<br />
==How to set up a Moodle Hub server==<br />
<br />
# Install Moodle 2.0 or later somewhere on a web server with a nice URL.<br />
# Download the latest hub plugin from https://github.com/moodlehq/moodle-local_hub<br />
# Save the zip into the /local directory of Moodle and unzip, producing /local/hub<br />
# Visit the "Notifications" page in Moodle (/admin) to complete the upgrade and install the hub software.<br />
# Uncheck password policy (passwordpolicy)<br />
# Allow extended characters in usernames (extendedusernamechars)<br />
# Enable web services for the hub (''Settings > Site Administration > Advanced features'')<br />
# Enable the XML-RPC protocol (''Settings > Site Administration > Plugins > Web services > Manage protocols'')<br />
# Set up the SMTP (''Settings > Site Administration > Plugins > Message outputs > Email'')<br />
# Set up the recaptcha (''Settings > Site Administration > Plugins > Authentication > Manage authentication'') <br />
# Set up your hub (''Settings > Site Administration > Hub > Settings'') Supply a description, enable the hub, supply a hub password.<br />
<br />
Congratulations! You now have a working hub with no content!<br />
<br />
==Site registration==<br />
<br />
Only sites that are registered with the hub are allowed to publish content there.<br />
<br />
Sites register on the hub via ''Settings > Site administration > Server > Hubs''.<br />
<br />
==Hub registration== <br />
<br />
You can also register your hub with the Moodle hub Directory, a listing of many hubs from around the world, enabling people from all over the world to find your hub and search the courses within it. You may want to wait until you have some content before you register.<br />
<br />
==Managing sites==<br />
In ''Settings > Site administration > Hub > Manage sites'', you can:<br />
* Prioritise a site: during a search, course from prioritised sites appear on top of the list. A prioritised site is always trusted.<br />
* Trust a site: when a site is trusted, any published course is immediately available<br />
* Delete a site: delete a site from the database. A message will be sent to the site administrator.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a site visible: only site declared as visible appear on the the site list (currently the site list hasn't been implemented)<br />
<br />
==Managing courses==<br />
In ''Settings > Site administration > Hub > Manage course'', you can:<br />
* Delete a course: delete a course from the database.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a course visible: decide if the course is displayed on search result<br />
<br />
== Important things about roles, users and web services ==<br />
A hub server uses intensively Moodle web service 2.0. For this reason it is important to understand the [https://docs.moodle.org/en/Web_Services web services administration], and what happens if you change some roles/users/services.<br />
<br />
=== Roles ===<br />
The hub server creates on the fly some roles that you should '''never delete/modify''':<br />
* one role for the hub directory<br />
* one role for registered sites<br />
* one role for public sites<br />
<br />
=== Users ===<br />
The hub server creates on the fly some users that you should '''never delete/modify''':<br />
* one user for the hub directory<br />
* one user for public access<br />
* as many users as registered sites<br />
<br />
=== Services ===<br />
The hub creates during installation some web services that you should '''never delete/modify''':<br />
* one service for Hub directory<br />
* one service for Registered sites<br />
* one service for Public sites<br />
<br />
It also creates tokens on the fly. These tokens are not displayed on the token management list, so you cannot accidentally delete them.<br />
<br />
==See also==<br />
<br />
*[[Site registration]]<br />
<br />
[[ja:ハブ管理]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Hub_administration&diff=103899Hub administration2013-04-08T09:46:01Z<p>Jmouneyrac: /* Minimal Requirements */</p>
<hr />
<div>{{Community hubs}}<br />
==Deciding to run a Hub==<br />
<br />
Running a hub server is not something you should undertake lightly. <br />
<br />
As the hub administrator you are responsible for the content in the hub, and you need to put in place processes to:<br />
* verify all the course content is clean (of porn or malicious javascript)<br />
* manage registered sites and their status <br />
* maintain the quality of the listings through editing<br />
<br />
=== Minimal Requirements ===<br />
<br />
Below is a list of Minimal requirements for running a Moodle Community Hub.<br />
<br />
* MySQL - minimum version 5.0.25<br />
* PHP 5.3.2<br />
* Apache<br />
* ensure that the site you will be registering does not use any upper case letters (even though those are perfectly valid). ''EG: moodle.org/2012-Spring will not work!''<br />
* ensure that the following php.ini variables are set to "On"<br />
** allow_url_fopen: This setting is required the hub to be able to register a site. If this option is not enabled, you will be given the [[error/local_hub/cannotregisternotavailablesite|cannotregisternotavailablesite]] error. Related tracker issue: https://tracker.moodle.org/browse/CONTRIB-3063<br />
* mod_security in Apache version 1 and mod_security2 in Apache version 2 will return a 403 forbidden error when a URL that is not the local domain is passed as a get variable. mod_security on either the hub or client servers will block the completion of the client/hub registration process, even to MOOCH, as within the registration process URL's are passed as get variables a number of times. An exception can be added to mod_security in Apache version 1 via a local .htacess file. However, this ability was removed in mod_security2. In mod_security2 the exception must be added to mod_security.conf of /conf.d. Related forum discussion: http://moodle.org/mod/forum/discuss.php?d=188933<br />
<br />
==How the hub software works==<br />
<br />
The hub software is implemented as a separate "local" plugin designed to be added to a standard install of Moodle 2.0 or later. In this way the hub gets to use on all the features in the Moodle core API and benefits from maintenance of the core code.<br />
<br />
Once installed the whole site gets a new frontpage with a simple search box (see http://hub.moodle.org/ for example).<br />
<br />
Please don't add the hub capabilities to an existing Moodle site with real courses. Although it may work, there are some opportunities for GUI confusion and some unknowns when it comes to security, so please just avoid it. Moodle is free, so it's trivial to install another clean copy to build your hub with.<br />
<br />
==How to set up a Moodle Hub server==<br />
<br />
# Install Moodle 2.0 or later somewhere on a web server with a nice URL.<br />
# Download the latest hub plugin from https://github.com/moodlehq/moodle-local_hub<br />
# Save the zip into the /local directory of Moodle and unzip, producing /local/hub<br />
# Visit the "Notifications" page in Moodle (/admin) to complete the upgrade and install the hub software.<br />
# Enable web services for the hub (''Settings > Site Administration > Advanced features'')<br />
# Enable the XML-RPC protocol (''Settings > Site Administration > Plugins > Web services > Manage protocols'')<br />
# Set up the SMTP (''Settings > Site Administration > Plugins > Message outputs > Email'')<br />
# Set up the recaptcha (''Settings > Site Administration > Plugins > Authentication > Manage authentication'') <br />
# Set up your hub (''Settings > Site Administration > Hub > Settings'') Supply a description, enable the hub, supply a hub password.<br />
<br />
Congratulations! You now have a working hub with no content!<br />
<br />
==Site registration==<br />
<br />
Only sites that are registered with the hub are allowed to publish content there.<br />
<br />
Sites register on the hub via ''Settings > Site administration > Server > Hubs''.<br />
<br />
==Hub registration== <br />
<br />
You can also register your hub with the Moodle hub Directory, a listing of many hubs from around the world, enabling people from all over the world to find your hub and search the courses within it. You may want to wait until you have some content before you register.<br />
<br />
==Managing sites==<br />
In ''Settings > Site administration > Hub > Manage sites'', you can:<br />
* Prioritise a site: during a search, course from prioritised sites appear on top of the list. A prioritised site is always trusted.<br />
* Trust a site: when a site is trusted, any published course is immediately available<br />
* Delete a site: delete a site from the database. A message will be sent to the site administrator.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a site visible: only site declared as visible appear on the the site list (currently the site list hasn't been implemented)<br />
<br />
==Managing courses==<br />
In ''Settings > Site administration > Hub > Manage course'', you can:<br />
* Delete a course: delete a course from the database.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a course visible: decide if the course is displayed on search result<br />
<br />
== Important things about roles, users and web services ==<br />
A hub server uses intensively Moodle web service 2.0. For this reason it is important to understand the [https://docs.moodle.org/en/Web_Services web services administration], and what happens if you change some roles/users/services.<br />
<br />
=== Roles ===<br />
The hub server creates on the fly some roles that you should '''never delete/modify''':<br />
* one role for the hub directory<br />
* one role for registered sites<br />
* one role for public sites<br />
<br />
=== Users ===<br />
The hub server creates on the fly some users that you should '''never delete/modify''':<br />
* one user for the hub directory<br />
* one user for public access<br />
* as many users as registered sites<br />
<br />
=== Services ===<br />
The hub creates during installation some web services that you should '''never delete/modify''':<br />
* one service for Hub directory<br />
* one service for Registered sites<br />
* one service for Public sites<br />
<br />
It also creates tokens on the fly. These tokens are not displayed on the token management list, so you cannot accidentally delete them.<br />
<br />
==See also==<br />
<br />
*[[Site registration]]<br />
<br />
[[ja:ハブ管理]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Hub_administration&diff=103898Hub administration2013-04-08T09:44:09Z<p>Jmouneyrac: /* Minimal Requirements */</p>
<hr />
<div>{{Community hubs}}<br />
==Deciding to run a Hub==<br />
<br />
Running a hub server is not something you should undertake lightly. <br />
<br />
As the hub administrator you are responsible for the content in the hub, and you need to put in place processes to:<br />
* verify all the course content is clean (of porn or malicious javascript)<br />
* manage registered sites and their status <br />
* maintain the quality of the listings through editing<br />
<br />
=== Minimal Requirements ===<br />
<br />
Below is a list of Minimal requirements for running a Moodle Community Hub.<br />
<br />
* Apache 2+ / MySQL 5+ / PHP 5.2+ <br />
* verify the server meets the requirements to run the latest version of Moodle found in the documents at [[Installing_Moodle#Requirements|Installing_Moodle]] and [[PHP]]<br />
* ensure that the site you will be registering does not use any upper case letters (even though those are perfectly valid). ''EG: moodle.org/2012-Spring will not work!''<br />
* ensure that the following php.ini variables are set to "On"<br />
** allow_url_fopen: This setting is required the hub to be able to register a site. If this option is not enabled, you will be given the [[error/local_hub/cannotregisternotavailablesite|cannotregisternotavailablesite]] error. Related tracker issue: https://tracker.moodle.org/browse/CONTRIB-3063<br />
* mod_security in Apache version 1 and mod_security2 in Apache version 2 will return a 403 forbidden error when a URL that is not the local domain is passed as a get variable. mod_security on either the hub or client servers will block the completion of the client/hub registration process, even to MOOCH, as within the registration process URL's are passed as get variables a number of times. An exception can be added to mod_security in Apache version 1 via a local .htacess file. However, this ability was removed in mod_security2. In mod_security2 the exception must be added to mod_security.conf of /conf.d. Related forum discussion: http://moodle.org/mod/forum/discuss.php?d=188933<br />
<br />
==How the hub software works==<br />
<br />
The hub software is implemented as a separate "local" plugin designed to be added to a standard install of Moodle 2.0 or later. In this way the hub gets to use on all the features in the Moodle core API and benefits from maintenance of the core code.<br />
<br />
Once installed the whole site gets a new frontpage with a simple search box (see http://hub.moodle.org/ for example).<br />
<br />
Please don't add the hub capabilities to an existing Moodle site with real courses. Although it may work, there are some opportunities for GUI confusion and some unknowns when it comes to security, so please just avoid it. Moodle is free, so it's trivial to install another clean copy to build your hub with.<br />
<br />
==How to set up a Moodle Hub server==<br />
<br />
# Install Moodle 2.0 or later somewhere on a web server with a nice URL.<br />
# Download the latest hub plugin from https://github.com/moodlehq/moodle-local_hub<br />
# Save the zip into the /local directory of Moodle and unzip, producing /local/hub<br />
# Visit the "Notifications" page in Moodle (/admin) to complete the upgrade and install the hub software.<br />
# Enable web services for the hub (''Settings > Site Administration > Advanced features'')<br />
# Enable the XML-RPC protocol (''Settings > Site Administration > Plugins > Web services > Manage protocols'')<br />
# Set up the SMTP (''Settings > Site Administration > Plugins > Message outputs > Email'')<br />
# Set up the recaptcha (''Settings > Site Administration > Plugins > Authentication > Manage authentication'') <br />
# Set up your hub (''Settings > Site Administration > Hub > Settings'') Supply a description, enable the hub, supply a hub password.<br />
<br />
Congratulations! You now have a working hub with no content!<br />
<br />
==Site registration==<br />
<br />
Only sites that are registered with the hub are allowed to publish content there.<br />
<br />
Sites register on the hub via ''Settings > Site administration > Server > Hubs''.<br />
<br />
==Hub registration== <br />
<br />
You can also register your hub with the Moodle hub Directory, a listing of many hubs from around the world, enabling people from all over the world to find your hub and search the courses within it. You may want to wait until you have some content before you register.<br />
<br />
==Managing sites==<br />
In ''Settings > Site administration > Hub > Manage sites'', you can:<br />
* Prioritise a site: during a search, course from prioritised sites appear on top of the list. A prioritised site is always trusted.<br />
* Trust a site: when a site is trusted, any published course is immediately available<br />
* Delete a site: delete a site from the database. A message will be sent to the site administrator.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a site visible: only site declared as visible appear on the the site list (currently the site list hasn't been implemented)<br />
<br />
==Managing courses==<br />
In ''Settings > Site administration > Hub > Manage course'', you can:<br />
* Delete a course: delete a course from the database.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a course visible: decide if the course is displayed on search result<br />
<br />
== Important things about roles, users and web services ==<br />
A hub server uses intensively Moodle web service 2.0. For this reason it is important to understand the [https://docs.moodle.org/en/Web_Services web services administration], and what happens if you change some roles/users/services.<br />
<br />
=== Roles ===<br />
The hub server creates on the fly some roles that you should '''never delete/modify''':<br />
* one role for the hub directory<br />
* one role for registered sites<br />
* one role for public sites<br />
<br />
=== Users ===<br />
The hub server creates on the fly some users that you should '''never delete/modify''':<br />
* one user for the hub directory<br />
* one user for public access<br />
* as many users as registered sites<br />
<br />
=== Services ===<br />
The hub creates during installation some web services that you should '''never delete/modify''':<br />
* one service for Hub directory<br />
* one service for Registered sites<br />
* one service for Public sites<br />
<br />
It also creates tokens on the fly. These tokens are not displayed on the token management list, so you cannot accidentally delete them.<br />
<br />
==See also==<br />
<br />
*[[Site registration]]<br />
<br />
[[ja:ハブ管理]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_app&diff=103856Mobile app2013-04-04T11:11:55Z<p>Jmouneyrac: </p>
<hr />
<div>{{Mobile}}<br />
<p class="note">'''Mobile app latest''': The ''Moodle Mobile'' app (developed on HTML5 and Phonegap) is replacing the old mobile app for iPhone, ''My Moodle''.</p><br />
<br />
== Features ==<br />
* upload a picture into your private file area<br />
* record an audio file and upload it into your private file area<br />
* send a private message to a course participant (can be done offline)<br />
* take a personal note about a course participant (can be done offline)<br />
* add a course participant to your phone contact<br />
* call a course participant touching the phone number<br />
* locate a course participant address on Google map<br />
* download and view some resources<br />
* quick access to your course contents<br />
<br />
==Moodle sites must be enabled for the app to access them==<br />
<br />
The administrator of your Moodle site (which must be version 2.4 or later) must enable mobile access as follows:<br />
<br />
* In ''Site administration > Plugins > Web services > Mobile'' tick the 'Enable web services for mobile devices' checkbox, then click the button to save changes.<br />
<br />
==Installing the mobile app==<br />
<br />
Android: https://play.google.com/store/apps/details?id=com.moodle.moodlemobile<br />
<br />
iOS: Coming soon<br />
<br />
==Testing the app on a demo site==<br />
<br />
In the login screen, type "teacher" or "student" in the Username field and click the Add button. You will be logged automatically to a Moodle demo site for testing the app.<br />
<br />
== Cache ==<br />
If you connect to your Moodle site and update/create/delete anything, and then go to your mobile app, the content will not be displayed. You will have to wait a couple of minutes. The cache time for the app is currently 5 minutes.<br />
<br />
==How to report a bug==<br />
<br />
# Log in to the [http://tracker.moodle.org/ Moodle Tracker] (you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] if you've not done so previously)<br />
# ''Check whether the issue has already been reported by searching''<br />
# If not, report the bug by clicking the 'Create Issue' link at the top right of the page, selecting 'Moodle Mobile' as the project<br />
# Add a detailed description then click the Create button<br />
# Attach the following files to the issue by selecting 'Attach Files' in the 'More actions' dropdown menu:<br />
#* 'Device information' - this can be found in the app (Settings -> Development -> Device info, you can send yourself this information by email using the e-mail button at the bottom)<br />
#* App Log (''Settings -> Development -> Show Log'', again you can send yourself this information by email)<br />
<br />
=== Report a bug by email ===<br />
You can send us the same report by email using ''Settings -> Report a bug''. As the report is sent by email to mobile@moodle.com, the report will take more time to be filed in the tracker.<br />
<br />
== See also ==<br />
<br />
* [[:dev:Moodle Mobile|Moodle Mobile developer docs]]<br />
* [[Mobile web services]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_app&diff=103777Mobile app2013-03-29T00:52:53Z<p>Jmouneyrac: /* Moodle sites must be enabled for the app to access them */</p>
<hr />
<div>{{Mobile}}<br />
<p class="note">'''Mobile app latest''': The ''Moodle Mobile'' app (developed on HTML5 and Phonegap) is replacing the old mobile app for iPhone, ''My Moodle''.</p><br />
<br />
== Features ==<br />
* upload a picture into your private file area<br />
* record an audio file and upload it into your private file area<br />
* send a private message to a course participant (can be done offline)<br />
* take a personal note about a course participant (can be done offline)<br />
* add a course participant to your phone contact<br />
* call a course participant touching the phone number<br />
* locate a course participant address on Google map<br />
* download and view some resources<br />
* quick access to your course contents<br />
<br />
==Moodle sites must be enabled for the app to access them==<br />
<br />
The administrator of your Moodle site (which must be version 2.4 or later) must enable mobile access as follows:<br />
<br />
* In ''Site administration > Plugins > Web services > Mobile'' tick the 'Enable web services for mobile devices' checkbox, then click the button to save changes.<br />
<br />
==Installing the mobile app==<br />
<br />
Android: https://play.google.com/store/apps/details?id=com.moodle.moodlemobile<br />
<br />
iOS: Coming soon<br />
<br />
==Testing the app on a demo site==<br />
<br />
In the login screen, type "teacher" or "student" in the Username field and click the Add button. You will be logged automatically to a Moodle demo site for testing the app.<br />
<br />
==How to report a bug==<br />
<br />
# Log in to the [http://tracker.moodle.org/ Moodle Tracker] (you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] if you've not done so previously)<br />
# ''Check whether the issue has already been reported by searching''<br />
# If not, report the bug by clicking the 'Create Issue' link at the top right of the page, selecting 'Moodle Mobile' as the project<br />
# Add a detailed description then click the Create button<br />
# Attach the following files to the issue by selecting 'Attach Files' in the 'More actions' dropdown menu:<br />
#* 'Device information' - this can be found in the app (Settings -> Development -> Device info, you can send yourself this information by email using the e-mail button at the bottom)<br />
#* App Log (''Settings -> Development -> Show Log'', again you can send yourself this information by email)<br />
<br />
=== Report a bug by email ===<br />
You can send us the same report by email using ''Settings -> Report a bug''. As the report is sent by email to mobile@moodle.com, the report will take more time to be filed in the tracker.<br />
<br />
== See also ==<br />
<br />
* [[:dev:Moodle Mobile|Moodle Mobile developer docs]]<br />
* [[Mobile web services]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_app&diff=103757Mobile app2013-03-27T03:39:26Z<p>Jmouneyrac: /* Features */</p>
<hr />
<div>{{Mobile}}<br />
<p class="note">'''Mobile app latest''': The ''Moodle Mobile'' app (developed on HTML5 and Phonegap) is replacing the old mobile app for iPhone, ''My Moodle''.</p><br />
<br />
== Features ==<br />
* upload a picture into your private file area<br />
* record an audio file and upload it into your private file area<br />
* send a private message to a course participant (can be done offline)<br />
* take a personal note about a course participant (can be done offline)<br />
* add a course participant to your phone contact<br />
* call a course participant touching the phone number<br />
* locate a course participant address on Google map<br />
* download and view some resources<br />
* quick access to your course contents<br />
<br />
==Moodle sites must be enabled for the app to access them==<br />
<br />
The administrator of your Moodle site (which must be version 2.4 or later) must enable mobile access as follows:<br />
<br />
# In ''Settings > Site administration > Advanced features'' tick the 'Enable web services' checkbox, then click the button to save changes<br />
# In ''Site administration > Plugins > Web services > Mobile'' tick the 'Enable web services for mobile devices' checkbox, then click the button to save changes. (Ticking the 'Enable web services' checkbox should enable this also, but doesn't always.)<br />
<br />
==Installing the mobile app==<br />
<br />
Android: https://play.google.com/store/apps/details?id=com.moodle.moodlemobile<br />
<br />
iOS: Coming soon<br />
<br />
==Testing the app on a demo site==<br />
<br />
In the login screen, type "teacher" or "student" in the Username field and click the Add button. You will be logged automatically to a Moodle demo site for testing the app.<br />
<br />
==How to report a bug==<br />
<br />
# Log in to the [http://tracker.moodle.org/ Moodle Tracker] (you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] if you've not done so previously)<br />
# ''Check whether the issue has already been reported by searching''<br />
# If not, report the bug by clicking the 'Create Issue' link at the top right of the page, selecting 'Moodle Mobile' as the project<br />
# Add a detailed description then click the Create button<br />
# Attach the following files to the issue by selecting 'Attach Files' in the 'More actions' dropdown menu:<br />
#* 'Device information' - this can be found in the app (Settings -> Development -> Device info, you can send yourself this information by email using the e-mail button at the bottom)<br />
#* App Log (Settings -> Development -> Show Log, again you can send yourself this information by email)<br />
<br />
=== by email ===<br />
You can send us the same report by email using Settings -> Report a bug. As the report is sent by email to mobile@moodle.com, the report will take more time to be filled in the tracker.<br />
<br />
== See also ==<br />
<br />
* [[:dev:Moodle Mobile|Moodle Mobile developer docs]]<br />
* [[Mobile web services]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_app&diff=103756Mobile app2013-03-27T03:29:03Z<p>Jmouneyrac: </p>
<hr />
<div>{{Mobile}}<br />
<p class="note">'''Mobile app latest''': The ''Moodle Mobile'' app (developed on HTML5 and Phonegap) is replacing the old mobile app for iPhone, ''My Moodle''.</p><br />
<br />
== Features ==<br />
* upload a picture into your private file area<br />
* record an audio file and upload it into your private file area<br />
* send a private message to a course participant (can be done offline)<br />
* take a personal note about a course participant (can be done offline)<br />
* add a course participant to your phone contact<br />
* call a course participant touching the phone number<br />
* locate a course participant address on Google map<br />
* download a PDF/DOC/Image/HTML resource<br />
<br />
==Moodle sites must be enabled for the app to access them==<br />
<br />
The administrator of your Moodle site (which must be version 2.4 or later) must enable mobile access as follows:<br />
<br />
# In ''Settings > Site administration > Advanced features'' tick the 'Enable web services' checkbox, then click the button to save changes<br />
# In ''Site administration > Plugins > Web services > Mobile'' tick the 'Enable web services for mobile devices' checkbox, then click the button to save changes. (Ticking the 'Enable web services' checkbox should enable this also, but doesn't always.)<br />
<br />
==Installing the mobile app==<br />
<br />
Android: https://play.google.com/store/apps/details?id=com.moodle.moodlemobile<br />
<br />
iOS: Coming soon<br />
<br />
==Testing the app on a demo site==<br />
<br />
In the login screen, type "teacher" or "student" in the Username field and click the Add button. You will be logged automatically to a Moodle demo site for testing the app.<br />
<br />
==How to report a bug==<br />
<br />
# Log in to the [http://tracker.moodle.org/ Moodle Tracker] (you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] if you've not done so previously)<br />
# ''Check whether the issue has already been reported by searching''<br />
# If not, report the bug by clicking the 'Create Issue' link at the top right of the page, selecting 'Moodle Mobile' as the project<br />
# Add a detailed description then click the Create button<br />
# Attach the following files to the issue by selecting 'Attach Files' in the 'More actions' dropdown menu:<br />
#* 'Device information' - this can be found in the app (Settings -> Development -> Device info, you can send yourself this information by email using the e-mail button at the bottom)<br />
#* App Log (Settings -> Development -> Show Log, again you can send yourself this information by email)<br />
<br />
=== by email ===<br />
You can send us the same report by email using Settings -> Report a bug. As the report is sent by email to mobile@moodle.com, the report will take more time to be filled in the tracker.<br />
<br />
== See also ==<br />
<br />
* [[:dev:Moodle Mobile|Moodle Mobile developer docs]]<br />
* [[Mobile web services]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_app&diff=103732Mobile app2013-03-22T03:05:20Z<p>Jmouneyrac: /* What is the app used for */</p>
<hr />
<div>{{Mobile}}<br />
<p class="note">'''Mobile app latest''': The ''Moodle Mobile'' app (developed on HTML5 and Phonegap) is replacing the old mobile app for iPhone, ''My Moodle''.</p><br />
<br />
== Features ==<br />
* upload a picture into your private file area<br />
* record an audio file and upload it into your private file area<br />
* send a private message to a course participant (can be done offline)<br />
* take a personal note about a course participant (can be done offline)<br />
* add a course participant to your phone contact<br />
* call a course participant touching the phone number<br />
* locate a course participant address on Google map<br />
* download a PDF/DOC/Image/HTML resource<br />
<br />
==Moodle sites must be enabled for the app to access them==<br />
<br />
The administrator of your Moodle site (which must be version 2.4 or later) must enable mobile access as follows:<br />
<br />
# In ''Settings > Site administration > Advanced features'' tick the 'Enable web services' checkbox, then click the button to save changes<br />
# In ''Site administration > Plugins > Web services > Mobile'' tick the 'Enable web services for mobile devices' checkbox, then click the button to save changes. (Ticking the 'Enable web services' checkbox should enable this also, but doesn't always.)<br />
<br />
==Installing the mobile app==<br />
<br />
Android: https://play.google.com/store/apps/details?id=com.moodle.moodlemobile<br />
<br />
iOS: Coming soon<br />
<br />
==Connecting to your Moodle site ==<br />
<br />
<br />
<br />
==Browsing courses==<br />
<br />
''Information coming soon...''<br />
<br />
==Uploading photos and audio==<br />
<br />
''Information coming soon...''<br />
<br />
==Managing multiple Moodle sites==<br />
<br />
==Notifications==<br />
<br />
Currently not available<br />
<br />
<br />
<br />
<br />
==Settings==<br />
<br />
''Information coming soon...''<br />
<br />
==Testing the app on a demo site==<br />
<br />
In the login screen, type "teacher" or "student" in the Username field and click the Add button. You will be logged automatically to a Moodle demo site for testing the app.<br />
<br />
==How to report a bug==<br />
<br />
# Log in to the [http://tracker.moodle.org/ Moodle Tracker] (you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] if you've not done so previously)<br />
# ''Check whether the issue has already been reported by searching''<br />
# If not, report the bug by clicking the 'Create Issue' link at the top right of the page, selecting 'Moodle Mobile' as the project<br />
# Add a detailed description then click the Create button<br />
# Attach the following files to the issue by selecting 'Attach Files' in the 'More actions' dropdown menu:<br />
#* 'Device information' - this can be found in the app (Settings -> Device info, you can send yourself this information by email using the e-mail button at the bottom)<br />
#* App Log (Settings -> Development -> Show Log, again you can send yourself this information by email)<br />
<br />
== See also ==<br />
<br />
* [[:dev:Moodle Mobile|Moodle Mobile developer docs]]<br />
* [[Mobile web services]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_app&diff=103731Mobile app2013-03-22T02:48:06Z<p>Jmouneyrac: </p>
<hr />
<div>{{Mobile}}<br />
<p class="note">'''Mobile app latest''': The ''Moodle Mobile'' app (developed on HTML5 and Phonegap) is replacing the old mobile app for iPhone, ''My Moodle''.</p><br />
<br />
== What is the app used for ==<br />
The app offers few features which have for advantage to be done quicker than on the Moodle site or to be done offline.<br />
* upload a picture into your private file (so you can use it in the file picker straight away)<br />
* record an audio file and upload into your private file (so you can use it in the file picker straight away)<br />
* send a private message to a student/teacher (faster than in Moodle + it works offline)<br />
* take a personal/reminder note about someone else (faster than in Moodle + it works offline)<br />
* add someone to your phone contact (you don’t need to copy/type details manually)<br />
* call someone touching the phone number (you don’t need to copy/type the number in your dialapp)<br />
* locate someone address on Google map (you don’t need to copy/type the address in the map)<br />
* view a PDF/DOC/Image/HTML resource (some resources can be downloaded to be used offline on your phone)<br />
<br />
==Moodle sites must be enabled for the app to access them==<br />
<br />
The administrator of your Moodle site (which must be version 2.4 or later) must enable mobile access as follows:<br />
<br />
# In ''Settings > Site administration > Advanced features'' tick the 'Enable web services' checkbox, then click the button to save changes<br />
# In ''Site administration > Plugins > Web services > Mobile'' tick the 'Enable web services for mobile devices' checkbox, then click the button to save changes. (Ticking the 'Enable web services' checkbox should enable this also, but doesn't always.)<br />
<br />
==Installing the mobile app==<br />
<br />
Android: https://play.google.com/store/apps/details?id=com.moodle.moodlemobile<br />
<br />
iOS: Coming soon<br />
<br />
==Connecting to your Moodle site ==<br />
<br />
<br />
<br />
==Browsing courses==<br />
<br />
''Information coming soon...''<br />
<br />
==Uploading photos and audio==<br />
<br />
''Information coming soon...''<br />
<br />
==Managing multiple Moodle sites==<br />
<br />
==Notifications==<br />
<br />
Currently not available<br />
<br />
<br />
<br />
<br />
==Settings==<br />
<br />
''Information coming soon...''<br />
<br />
==Testing the app on a demo site==<br />
<br />
In the login screen, type "teacher" or "student" in the Username field and click the Add button. You will be logged automatically to a Moodle demo site for testing the app.<br />
<br />
==How to report a bug==<br />
<br />
# Log in to the [http://tracker.moodle.org/ Moodle Tracker] (you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] if you've not done so previously)<br />
# ''Check whether the issue has already been reported by searching''<br />
# If not, report the bug by clicking the 'Create Issue' link at the top right of the page, selecting 'Moodle Mobile' as the project<br />
# Add a detailed description then click the Create button<br />
# Attach the following files to the issue by selecting 'Attach Files' in the 'More actions' dropdown menu:<br />
#* 'Device information' - this can be found in the app (Settings -> Device info, you can send yourself this information by email using the e-mail button at the bottom)<br />
#* App Log (Settings -> Development -> Show Log, again you can send yourself this information by email)<br />
<br />
== See also ==<br />
<br />
* [[:dev:Moodle Mobile|Moodle Mobile developer docs]]<br />
* [[Mobile web services]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_web_services&diff=102166Mobile web services2012-11-26T07:29:22Z<p>Jmouneyrac: </p>
<hr />
<div>{{Web services}}<br />
Moodle comes with a built-in web service designed for mobile applications. It is required to run the official [[dev:Moodle Mobile]]. Enable it only if you want people to use the official app or if a third party app explicitly requires it.<br />
<br />
== Enabling mobile web services ==<br />
<br />
A site administrator first must enable mobile web services:<br />
<br />
*In ''Settings > Site administration > Plugins > Web services > Mobile'' <br />
*Check "Enable mobile web services" and then<br />
*Click Save.<br />
<br />
That's it! No other steps required.<br />
<br />
The rest of this document explains the "behind the scenes".<br />
<br />
== What happens when the service is enabled ==<br />
Enabling the mobile web services will automatically:<br />
* enable the web services system (''Settings > Site administration > Advanced features'')<br />
* enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled<br />
* enable the xml-rpc protocol (for backward compatibility with unmaintained My Moodle app)<br />
* enable the rest protocol<br />
* allow the 'webservice/xmlrpc:use' capability for authenticated user role<br />
* allow the 'webservice/rest:use' capability for authenticated user role<br />
<br />
== Disabling mobile web services ==<br />
When you uncheck 'Enable mobile web services', it will automatically:<br />
* disable the external service called 'Mobile web services'.<br />
*if 'Mobile web services' was the only external service enabled:<br />
** disable the web services system<br />
** disable the xml-rpc protocol<br />
** disable the rest protocol<br />
** remove the 'webservice/xmlrpc:use' capability for authenticated user role<br />
** remove the 'webservice/rest:use' capability for authenticated user role<br />
<br />
==See also==<br />
* [[Mobile app]]<br />
<br />
[[Category:Mobile]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_web_services&diff=102165Mobile web services2012-11-26T07:27:28Z<p>Jmouneyrac: </p>
<hr />
<div>{{Web services}}<br />
Moodle comes with a built-in web service designed for mobile applications. It is required to run the official [[Mobile app]]. Enable it only if you want people to use the official app or if a third party app explicitly requires it.<br />
<br />
== Enabling mobile web services ==<br />
<br />
A site administrator first must enable mobile web services:<br />
<br />
*In ''Settings > Site administration > Plugins > Web services > Mobile'' <br />
*Check "Enable mobile web services" and then<br />
*Click Save.<br />
<br />
That's it! No other steps required.<br />
<br />
The rest of this document explains the "behind the scenes".<br />
<br />
== What happens when the service is enabled ==<br />
Enabling the mobile web services will automatically:<br />
* enable the web services system (''Settings > Site administration > Advanced features'')<br />
* enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled<br />
* enable the xml-rpc protocol (for backward compatibility with unmaintained My Moodle app)<br />
* enable the rest protocol<br />
* allow the 'webservice/xmlrpc:use' capability for authenticated user role<br />
* allow the 'webservice/rest:use' capability for authenticated user role<br />
<br />
== Disabling mobile web services ==<br />
When you uncheck 'Enable mobile web services', it will automatically:<br />
* disable the external service called 'Mobile web services'.<br />
*if 'Mobile web services' was the only external service enabled:<br />
** disable the web services system<br />
** disable the xml-rpc protocol<br />
** disable the rest protocol<br />
** remove the 'webservice/xmlrpc:use' capability for authenticated user role<br />
** remove the 'webservice/rest:use' capability for authenticated user role<br />
<br />
==See also==<br />
* [[Mobile app]]<br />
<br />
[[Category:Mobile]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Hub_administration&diff=97759Hub administration2012-05-16T06:53:05Z<p>Jmouneyrac: /* How to set up a Moodle Hub server */</p>
<hr />
<div>{{Community hubs}}<br />
==Deciding to run a Hub==<br />
<br />
Running a hub server is not something you should undertake lightly. <br />
<br />
As the hub administrator you are responsible for the content in the hub, and you need to put in place processes to:<br />
* verify all the course content is clean (of porn or malicious javascript)<br />
* manage registered sites and their status <br />
* maintain the quality of the listings through editing<br />
<br />
=== Minimal Requirements ===<br />
<br />
Below is a list of Minimal requirements for running a Moodle Community Hub.<br />
<br />
* verify the server meets the requirements to run the latest version of Moodle found in the documents at [[Installing_Moodle#Requirements|Installing_Moodle]] and [[PHP]]<br />
* ensure that the following php.ini variables are set to "On"<br />
** allow_url_fopen: This setting is required the hub to be able to register a site. If this option is not enabled, you will be given the [[error/local_hub/cannotregisternotavailablesite|cannotregisternotavailablesite]] error. Related tracker issue: https://tracker.moodle.org/browse/CONTRIB-3063<br />
* mod_security in Apache version 1 and mod_security2 in Apache version 2 will return a 403 forbidden error when a URL that is not the local domain is passed as a get variable. mod_security on either the hub or client servers will block the completion of the client/hub registration process, even to MOOCH, as within the registration process URL's are passed as get variables a number of times. An exception can be added to mod_security in Apache version 1 via a local .htacess file. However, this ability was removed in mod_security2. In mod_security2 the exception must be added to mod_security.conf of /conf.d. Related forum discussion: http://moodle.org/mod/forum/discuss.php?d=188933<br />
<br />
==How the hub software works==<br />
<br />
The hub software is implemented as a separate "local" plugin designed to be added to a standard install of Moodle 2.0 or later. In this way the hub gets to use on all the features in the Moodle core API and benefits from maintenance of the core code.<br />
<br />
Once installed the whole site gets a new frontpage with a simple search box (see http://hub.moodle.org/ for example).<br />
<br />
Please don't add the hub capabilities to an existing Moodle site with real courses. Although it may work, there are some opportunities for GUI confusion and some unknowns when it comes to security, so please just avoid it. Moodle is free, so it's trivial to install another clean copy to build your hub with.<br />
<br />
<br />
==How to set up a Moodle Hub server==<br />
<br />
# Install Moodle 2.0 or later somewhere on a web server with a nice URL.<br />
# Download the latest hub plugin from http://download.moodle.org/download.php/plugins/local/hub.zip<br />
# Save the zip into the /local directory of Moodle and unzip, producing /local/hub<br />
# Visit the "Notifications" page in Moodle (/admin) to complete the upgrade and install the hub software.<br />
# Enable web services for the hub ('''Site Administration > Advanced features''')<br />
# Enable the XML-RPC protocol ('''Site Administration > Plugins > Web services > Manage protocols''')<br />
# Set up the SMTP ('''Site Administration > Plugins > Message outputs > Email''')<br />
#Set up the recaptcha ('''Site Administration > Plugins > Authentication > Manage authentication''') <br />
# Set up your hub ('''Site Administration > Hub > Settings''')<br />
# In '''Site Administration > Security > Site policies''' enable ''Allow extended characters in usernames''. This step will be automatically executed when CONTRIB-3646 is done.<br />
<br />
Congratulations! You now have a working hub with no content!<br />
<br />
==Site registration==<br />
<br />
Only sites that are registered with the hub are allowed to publish content there.<br />
<br />
Sites register on the hub via '''Site Administration > Registration'''<br />
<br />
==Hub registration== <br />
<br />
You can also register your hub with the Moodle hub Directory, a listing of many hubs from around the world, enabling people from all over the world to find your hub and search the courses within it. You may want to wait until you have some content before you register.<br />
<br />
==Managing sites==<br />
In '''Administration > Hub > Manage sites''', you can:<br />
* Prioritise a site: during a search, course from prioritised sites appear on top of the list. A prioritised site is always trusted.<br />
* Trust a site: when a site is trusted, any published course is immediatly available<br />
* Delete a site: delete a site from the database. A message will be sent to the site administrator.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a site visible: only site declared as visible appear on the the site list (currently the site list hasn't been implemented)<br />
<br />
==Managing courses==<br />
In '''Administration > Hub > Manage course''', you can:<br />
* Delete a course: delete a course from the database.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a course visible: decide if the course is displayed on search result<br />
<br />
== Important things about roles, users and web services ==<br />
A hub server uses intensively Moodle web service 2.0. For this reason it is important to understand the [https://docs.moodle.org/en/Web_Services web services administration], and what happens if you change some roles/users/services.<br />
<br />
=== Roles ===<br />
The hub server creates on the fly some roles that you should '''never delete/modify''':<br />
* one role for the hub directory<br />
* one role for registered sites<br />
* one role for public sites<br />
<br />
=== Users ===<br />
The hub server creates on the fly some users that you should '''never delete/modify''':<br />
* one user for the hub directory<br />
* one user for public access<br />
* as many users as registered sites<br />
<br />
=== Services ===<br />
The hub creates during installation some web services that you should '''never delete/modify''':<br />
* one service for Hub directory<br />
* one service for Registered sites<br />
* one service for Public sites<br />
<br />
It also creates tokens on the fly. These tokens are not displayed on the token management list, so you cannot accidentally delete them.<br />
<br />
==See also==<br />
<br />
*[[Site registration]]<br />
<br />
[[ja:ハブ管理]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_Moodle_FAQ&diff=95389Mobile Moodle FAQ2012-01-24T02:31:49Z<p>Jmouneyrac: /* Where can I download the official Mobile app for iPhone? */</p>
<hr />
<div>{{Mobile}}<br />
== How can I use Moodle on mobile devices? ==<br />
There are currently 3 main ways to use Moodle on mobile devices:<br />
<br />
* Users can open Moodle sites in their mobile web browsers.<br />
* Users can download native apps for their mobile devices.<br />
* Admins can configure their Moodle site to be Mobile-accessible through server extensions.<br />
<br />
=== Mobile Apps ===<br />
* [http://www.moodletouch.com MoodleTouch] (aka ''mTouch'') for iOS, created by Ali OzGur.<br />
* [http://mpage.hk/ mPage] for iOS and Android (work in progress), created by Mass Media HK.<br />
* [http://codeguild.org/app/mbot/ Mbot] for Android, created by Code Guild.<br />
* The official [[Mobile app]] for iPhone, created by Moodle HQ.<br />
* [https://market.android.com/details?id=com.ivoid.droodle Droodle] - an Android client for the Moodle 2.1 platform<br />
<br />
=== Server-side ===<br />
* [http://www.mobilemoodle.org/momo18/ MoMo] (Moodle for Mobiles) - Requires a server extension and a client app; supports most mobile OSes including Symbian.<br />
* [http://mle.sourceforge.net MLE-Moodle] - Allows course designers to make a separate set of Moodle pages for mobile users.<br />
* [http://code.google.com/p/moodbile/ Moodbile] - Reference implementation of Moodle Web Services. Under development.<br />
* [http://iphone.moodle.com.au iPhone4Moodle] - Under development.<br />
<br />
==Where can I download the official Mobile app for iPhone (My Moodle)?==<br />
<br />
The Mobile app, My Moodle, can be downloaded for free from the Apple Online Store http://itunes.apple.com/ie/app/my-moodle/id461289000.<br />
<br />
==How do I get the official Mobile app to work for my Moodle site?==<br />
<br />
Firstly, your Moodle site must be using Moodle 2.1 or later.<br />
<br />
Secondly mobile web services must be enabled. See [[Enable mobile web services]] for details. <br />
<br />
==When will there be an official Mobile app for Android?==<br />
<br />
The Android app is expected to be ready around Christmas or soon after. (Source: [[:dev:Developer meeting November 2011|Nov 2011 developer meeting notes]])<br />
<br />
==Where can I select a theme for mobile devices?==<br />
<br />
In ''Site administration > Appearance > Themes > Theme selector''.<br />
<br />
New in Moodle 2.2 onwards is the MyMobile theme especially designed for mobile devices. <br />
<br />
==See also==<br />
<br />
* [http://moodle.org/mod/forum/view.php?id=7798 Moodle for mobile forum]<br />
* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=162872 Proposal for Supporting Mobile Themes and Browser Detection] forum discussion<br />
* An open course, about "[http://tempus-efa.proj.ac.il/moodle/course/view.php?id=102 Teaching using Mobile - Best practices]"<br />
* [http://www.moodlenews.com/mobile/ Moodle News - Mobile] - a breakdown of the mobile projects and products available<br />
<br />
[[Category:FAQ]]<br />
<br />
[[fr:Moodle pour les mobiles]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Hub_administration&diff=94464Hub administration2011-12-12T03:43:02Z<p>Jmouneyrac: /* Minimal Requirements */</p>
<hr />
<div>{{Community hubs}}<br />
==Deciding to run a Hub==<br />
<br />
Running a hub server is not something you should undertake lightly. <br />
<br />
As the hub administrator you are responsible for the content in the hub, and you need to put in place processes to:<br />
* verify all the course content is clean (of porn or malicious javascript)<br />
* manage registered sites and their status <br />
* maintain the quality of the listings through editing<br />
<br />
=== Minimal Requirements ===<br />
<br />
Below is a list of Minimal requirements for running a Moodle Community Hub.<br />
<br />
* verify the server meets the requirements to run the latest version of Moodle found in the documents at [[Installing_Moodle#Requirements|Installing_Moodle]] and [[PHP]]<br />
* ensure that the following php.ini variables are set to "On"<br />
** allow_url_fopen: This setting is required the hub to be able to register a site. If this option is not enabled, you will be given the [[error/local_hub/cannotregisternotavailablesite|cannotregisternotavailablesite]] error. Related tracker issue: https://tracker.moodle.org/browse/CONTRIB-3063<br />
* mod_security in Apache version 1 and mod_security2 in Apache version 2 will return a 403 forbidden error when a URL that is not the local domain is passed as a get variable. mod_security on either the hub or client servers will block the completion of the client/hub registration process, even to MOOCH, as within the registration process URL's are passed as get variables a number of times. An exception can be added to mod_security in Apache version 1 via a local .htacess file. However, this ability was removed in mod_security2. In mod_security2 the exception must be added to mod_security.conf of /conf.d. Related forum discussion: http://moodle.org/mod/forum/discuss.php?d=188933<br />
<br />
==How the hub software works==<br />
<br />
The hub software is implemented as a separate "local" plugin designed to be added to a standard install of Moodle 2.0 or later. In this way the hub gets to use on all the features in the Moodle core API and benefits from maintenance of the core code.<br />
<br />
Once installed the whole site gets a new frontpage with a simple search box (see http://hub.moodle.org/ for example).<br />
<br />
Please don't add the hub capabilities to an existing Moodle site with real courses. Although it may work, there are some opportunities for GUI confusion and some unknowns when it comes to security, so please just avoid it. Moodle is free, so it's trivial to install another clean copy to build your hub with.<br />
<br />
<br />
==How to set up a Moodle Hub server==<br />
<br />
# Install Moodle 2.0 or later somewhere on a web server with a nice URL.<br />
# Download the latest hub plugin from http://download.moodle.org/download.php/plugins/local/hub.zip<br />
# Save the zip into the /local directory of Moodle and unzip, producing /local/hub<br />
# Visit the "Notifications" page in Moodle (/admin) to complete the upgrade and install the hub software.<br />
# Enable web services for the hub ('''Site Administration > Advanced features''')<br />
# Enable the XML-RPC protocol ('''Site Administration > Plugins > Web services > Manage protocols''')<br />
# Set up the SMTP ('''Site Administration > Plugins > Message outputs > Email''')<br />
#Set up the recaptcha ('''Site Administration > Plugins > Authentication > Manage authentication''') <br />
# Set up your hub ('''Site Administration > Hub > Settings''')<br />
<br />
Congratulations! You now have a working hub with no content!<br />
<br />
==Site registration==<br />
<br />
Only sites that are registered with the hub are allowed to publish content there.<br />
<br />
Sites register on the hub via '''Site Administration > Registration'''<br />
<br />
==Hub registration== <br />
<br />
You can also register your hub with the Moodle hub Directory, a listing of many hubs from around the world, enabling people from all over the world to find your hub and search the courses within it. You may want to wait until you have some content before you register.<br />
<br />
==Managing sites==<br />
In '''Administration > Hub > Manage sites''', you can:<br />
* Prioritise a site: during a search, course from prioritised sites appear on top of the list. A prioritised site is always trusted.<br />
* Trust a site: when a site is trusted, any published course is immediatly available<br />
* Delete a site: delete a site from the database. A message will be sent to the site administrator.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a site visible: only site declared as visible appear on the the site list (currently the site list hasn't been implemented)<br />
<br />
==Managing courses==<br />
In '''Administration > Hub > Manage course''', you can:<br />
* Delete a course: delete a course from the database.<br />
* Settings: you can change some information as the name, the description, the language...<br />
* Make a course visible: decide if the course is displayed on search result<br />
<br />
== Important things about roles, users and web services ==<br />
A hub server uses intensively Moodle web service 2.0. For this reason it is important to understand the [https://docs.moodle.org/en/Web_Services web services administration], and what happens if you change some roles/users/services.<br />
<br />
=== Roles ===<br />
The hub server creates on the fly some roles that you should '''never delete/modify''':<br />
* one role for the hub directory<br />
* one role for registered sites<br />
* one role for public sites<br />
<br />
=== Users ===<br />
The hub server creates on the fly some users that you should '''never delete/modify''':<br />
* one user for the hub directory<br />
* one user for public access<br />
* as many users as registered sites<br />
<br />
=== Services ===<br />
The hub creates during installation some web services that you should '''never delete/modify''':<br />
* one service for Hub directory<br />
* one service for Registered sites<br />
* one service for Public sites<br />
<br />
It also creates tokens on the fly. These tokens are not displayed on the token management list, so you cannot accidentally delete them.<br />
<br />
==See also==<br />
<br />
*[[Site registration]]<br />
<br />
[[ja:ハブ管理]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services_FAQ&diff=94165Web services FAQ2011-11-29T02:36:27Z<p>Jmouneyrac: </p>
<hr />
<div>{{Web services}}<br />
This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum].<br />
<br />
== What is the difference between web services and MNet ==<br />
<br />
[[MNet]] is used to authenticate some users from a Moodle A site into a Moodle B site.<br />
<br />
Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).<br />
<br />
== I see the term "Web services" used in different ways, what does it mean? ==<br />
<br />
# The entire system in Moodle is referred to as the Moodle Web Service system.<br />
# A particular action (like creating a user) is known as a Web service '''function'''.<br />
# The admin can enable groups of these functions for outside use, and these are known as a "Web service".<br />
<br />
== Where is the Web Service API documented? ==<br />
<br />
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.<br />
<br />
'''Full API documentation'''<br />
# Connect as admin<br />
# Go to Administration Settings block > Plugins > Web services > API documentation<br />
<br />
'''Specific documentation to a user'''<br />
# 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]].<br />
# connect as non admin, and access the service documentation on your [[How_to_get_a_security_key|security keys page]].<br />
<br />
== Why are there not many functions in the API? ==<br />
<br />
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). <br />
<br />
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]].<br />
<br />
You can also extend the API on your own Moodle site by creating your own API functions (see next question).<br />
<br />
== How can I create a new web service function? ==<br />
<br />
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]].<br />
<br />
== How can I set up a web service? ==<br />
<br />
* See the document [[How_to_create_and_enable_a_web_service| How to create and enable a web service]]. <br />
* ''Settings > Site administration > Plugins > Web services > Overview'' explains two use cases.<br />
* Finally ask questions on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]<br />
<br />
== Does the Moodle SOAP server work with JAVA or .NET? ==<br />
<br />
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.<br />
<br />
== How to get a user token from an external application? ==<br />
you can generate and retrieve user tokens with the /login/token.php file => [[:dev:Creating_a_web_service_client#How_to_get_a_user_token|How to get a user token]]<br />
<br />
== What is the 'Access control exception' error ==<br />
It means that one of this admin setting has failed:<br />
* authorised user: ip restriction fails to authenticate the user (Administration > Plugins > Web services > Manage services > Authorized users > click on user full name)<br />
* authorised user: valid date is expired (Administration > Plugins > Web services > Manage services > Authorized users > click on user full name)<br />
* admin created the token: ip restriction fails to authenticate the user (Administration > Plugins > Web services > Manage tokens > check the status)<br />
* admin created the token: valid date is expired (Administration > Plugins > Web services > Manage tokens > check the status)<br />
* the user is not listed in the authorized list (Administration > Plugins > Web services > Manage services > Authorized users)<br />
* the user hasn't the required capability (Administration > Plugins > Web services > Manage services > Edit service)<br />
* site in maintenance mode<br />
* user is suspended<br />
* user is not confirmed<br />
* user is deleted<br />
* the user authentication is set to nologin (edit the user profile)<br />
* password expired (most likely happens with external authentication like LDAP)<br />
* web service disabled (Administration > Advanced features)<br />
<br />
Since Moodle 2.2, if the administrator turns Moodle debug mode >= NORMAL, then a explicit error message will be returned.<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]<br />
<br />
[[Category:MNet]]<br />
[[Category:FAQ]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services_FAQ&diff=94014Web services FAQ2011-11-23T05:46:25Z<p>Jmouneyrac: /* How to get a user token from an external application? */</p>
<hr />
<div>{{Web services}}<br />
This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum].<br />
<br />
== What is the difference between web services and MNet ==<br />
<br />
[[MNet]] is used to authenticate some users from a Moodle A site into a Moodle B site.<br />
<br />
Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).<br />
<br />
== I see the term "Web services" used in different ways, what does it mean? ==<br />
<br />
# The entire system in Moodle is referred to as the Moodle Web Service system.<br />
# A particular action (like creating a user) is known as a Web service '''function'''.<br />
# The admin can enable groups of these functions for outside use, and these are known as a "Web service".<br />
<br />
== Where is the Web Service API documented? ==<br />
<br />
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.<br />
<br />
'''Full API documentation'''<br />
# Connect as admin<br />
# Go to Administration Settings block > Plugins > Web services > API documentation<br />
<br />
'''Specific documentation to a user'''<br />
# 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]].<br />
# connect as non admin, and access the service documentation on your [[How_to_get_a_security_key|security keys page]].<br />
<br />
== Why are there not many functions in the API? ==<br />
<br />
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). <br />
<br />
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]].<br />
<br />
You can also extend the API on your own Moodle site by creating your own API functions (see next question).<br />
<br />
== How can I create a new web service function? ==<br />
<br />
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]].<br />
<br />
== How can I set up a web service? ==<br />
<br />
* See the document [[How_to_create_and_enable_a_web_service| How to create and enable a web service]]. <br />
* ''Settings > Site administration > Plugins > Web services > Overview'' explains two use cases.<br />
* Finally ask questions on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]<br />
<br />
== Does the Moodle SOAP server work with JAVA or .NET? ==<br />
<br />
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.<br />
<br />
== How to get a user token from an external application? ==<br />
you can generate and retrieve user tokens with the /login/token.php file => [[:dev:Creating_a_web_service_client#How_to_get_a_user_token|How to get a user token]]<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]<br />
<br />
[[Category:MNet]]<br />
[[Category:FAQ]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services_FAQ&diff=94013Web services FAQ2011-11-23T05:44:42Z<p>Jmouneyrac: </p>
<hr />
<div>{{Web services}}<br />
This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum].<br />
<br />
== What is the difference between web services and MNet ==<br />
<br />
[[MNet]] is used to authenticate some users from a Moodle A site into a Moodle B site.<br />
<br />
Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).<br />
<br />
== I see the term "Web services" used in different ways, what does it mean? ==<br />
<br />
# The entire system in Moodle is referred to as the Moodle Web Service system.<br />
# A particular action (like creating a user) is known as a Web service '''function'''.<br />
# The admin can enable groups of these functions for outside use, and these are known as a "Web service".<br />
<br />
== Where is the Web Service API documented? ==<br />
<br />
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.<br />
<br />
'''Full API documentation'''<br />
# Connect as admin<br />
# Go to Administration Settings block > Plugins > Web services > API documentation<br />
<br />
'''Specific documentation to a user'''<br />
# 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]].<br />
# connect as non admin, and access the service documentation on your [[How_to_get_a_security_key|security keys page]].<br />
<br />
== Why are there not many functions in the API? ==<br />
<br />
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). <br />
<br />
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]].<br />
<br />
You can also extend the API on your own Moodle site by creating your own API functions (see next question).<br />
<br />
== How can I create a new web service function? ==<br />
<br />
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]].<br />
<br />
== How can I set up a web service? ==<br />
<br />
* See the document [[How_to_create_and_enable_a_web_service| How to create and enable a web service]]. <br />
* ''Settings > Site administration > Plugins > Web services > Overview'' explains two use cases.<br />
* Finally ask questions on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]<br />
<br />
== Does the Moodle SOAP server work with JAVA or .NET? ==<br />
<br />
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.<br />
<br />
== How to get a user token from an external application? ==<br />
In Moodle 2.2 you can generate and retrieve user tokens with the /login/token.php file => [[:dev:Creating_a_web_service_client#How_to_get_a_user_token|How to get a user token]]<br />
<br />
The condition being that the service need a shortname. At the moment a service can have a shortname if you:<br />
* create the service as a built-in service (in db/services.php files) <br />
* add the shortname manually in the DB. Note: we'll add the admin UI for shortname later (MDL-30229) <br />
<br />
Just for the info, the file login/token.php exists since 2.1 but for this Moodle version it can only generate token for the mobile service.<br />
<br />
==See also==<br />
<br />
* Using Moodle [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]<br />
<br />
[[Category:MNet]]<br />
[[Category:FAQ]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93235Web services2011-11-02T08:59:42Z<p>Jmouneyrac: /* See also */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Developer documentation:<br />
* [[Development:Web_services | Web services]]<br />
* [[:dev:Web_services_Roadmap | Web service Roadmap]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93234Web services2011-11-02T08:44:57Z<p>Jmouneyrac: /* See also */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Developer documentation:<br />
* [[Development:Web_services | Web services]]<br />
* [[Development:Web_services_Roadmap | Web service Roadmap]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93233Web services2011-11-02T08:44:02Z<p>Jmouneyrac: /* See also */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Developer documentation:<br />
* [[Development:Web_services | Web services]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93232Web services2011-11-02T08:35:15Z<p>Jmouneyrac: </p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Developer documentation:<br />
* [[Development:Web_services | Web services]]<br />
* [[Development:External services security | External services security]]<br />
* [[Development:External services description | External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93231Web services2011-11-02T08:33:28Z<p>Jmouneyrac: /* See also */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
<br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Developer documentation:<br />
* [[Development:Web_services | Web services]]<br />
* [[Development:External services security | External services security]]<br />
* [[Development:External services description | External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93230Web services2011-11-02T08:32:45Z<p>Jmouneyrac: /* See also */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
<br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Developer documentation:<br />
* [[Development:Web_services | Developer documentation]]<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93229Web services2011-11-02T08:31:58Z<p>Jmouneyrac: /* Developer documentation */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
<br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Specification / core development / brainstorming:<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93228Web services2011-11-02T08:29:46Z<p>Jmouneyrac: </p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
<br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
== Developer documentation==<br />
The full API can be founnd on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.<br />
<br />
* [[Development:Creating a web service and a web service function | Implement a web service and a web service function]]<br />
* [[Development:Creating a web service client | Implement a web service client]]<br />
* [https://docs.moodle.org/dev/Web_services_Roadmap Web service Roadmap]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Specification / core development / brainstorming:<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93203Web services2011-11-02T02:18:31Z<p>Jmouneyrac: /* See also */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
=== How it works ===<br />
This simple example will give you an idea of how our web services infrastructure works. <br />
#The client sends a username and password to the web service login script.<br />
#The script returns a token for that user account.<br />
#The client calls a particular web service function on a protocol server including the token .<br />
#The protocol server uses the token to check that the user can call the function.<br />
#The protocol server call the matching external function, located in a externallib.php file inside the relevant module.<br />
#The external function checks that the current user has_capability to do this operation.<br />
#The external function calls the matching Moodle core function (in lib.php usually).<br />
#The core function can return a result to the external function. <br />
#The external function will return a result to the protocol server.<br />
#The protocol server returns the result to the client.<br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
== Developer documentation==<br />
The full API can be founnd on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.<br />
<br />
* [[Development:Creating a web service and a web service function | Implement a web service and a web service function]]<br />
* [[Development:Creating a web service client | Implement a web service client]]<br />
* [https://docs.moodle.org/dev/Web_services_Roadmap Web service Roadmap]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Specification / core development / brainstorming:<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_web_services&diff=93202Mobile web services2011-11-02T02:12:19Z<p>Jmouneyrac: /* See also */</p>
<hr />
<div>{{Mobile}}<br />
{{Moodle 2.1}}Moodle 2.1 comes with a built-in web service designed for mobile applications. It is required to run the official [[Mobile app]]. Enable it only if you want people to use the official app or if a third party app explicitly requires it.<br />
<br />
== Enabling mobile web services ==<br />
<br />
A site administrator first must enable mobile web services:<br />
<br />
*In ''Settings > Site administration > Plugins > Web services > External services'' <br />
*Check "Enable mobile web services" and then<br />
*Click Save.<br />
<br />
That's it! No other steps required.<br />
<br />
The rest of this document explains the "behind the scenes".<br />
<br />
== What happens when the service is enabled ==<br />
Enabling the mobile web services will automatically:<br />
* enable the web services system (''Settings > Site administration > Advanced features'')<br />
* enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled<br />
* enable the xml-rpc protocol<br />
* allow the 'webservice/xmlrpc:use' capability for authenticated user role<br />
<br />
== Disabling mobile web services ==<br />
When you uncheck 'Enable mobile web services', it will automatically:<br />
* disable the external service called 'Mobile web services'.<br />
*if 'Mobile web services' was the only external service enabled:<br />
** disable the web services system<br />
** disable the xml-rpc protocol<br />
** remove the 'webservice/xmlrpc:use' capability for authenticated user role<br />
<br />
==See also==<br />
* [[Web_services|Web Services]]<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
<br />
[[Category:Web Services]]<br />
[[Category:Mobile]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Mobile_web_services&diff=93201Mobile web services2011-11-02T02:11:12Z<p>Jmouneyrac: /* See also */</p>
<hr />
<div>{{Mobile}}<br />
{{Moodle 2.1}}Moodle 2.1 comes with a built-in web service designed for mobile applications. It is required to run the official [[Mobile app]]. Enable it only if you want people to use the official app or if a third party app explicitly requires it.<br />
<br />
== Enabling mobile web services ==<br />
<br />
A site administrator first must enable mobile web services:<br />
<br />
*In ''Settings > Site administration > Plugins > Web services > External services'' <br />
*Check "Enable mobile web services" and then<br />
*Click Save.<br />
<br />
That's it! No other steps required.<br />
<br />
The rest of this document explains the "behind the scenes".<br />
<br />
== What happens when the service is enabled ==<br />
Enabling the mobile web services will automatically:<br />
* enable the web services system (''Settings > Site administration > Advanced features'')<br />
* enable the built-in external service called 'Mobile web services' - you should see this new mobile service listed as enabled<br />
* enable the xml-rpc protocol<br />
* allow the 'webservice/xmlrpc:use' capability for authenticated user role<br />
<br />
== Disabling mobile web services ==<br />
When you uncheck 'Enable mobile web services', it will automatically:<br />
* disable the external service called 'Mobile web services'.<br />
*if 'Mobile web services' was the only external service enabled:<br />
** disable the web services system<br />
** disable the xml-rpc protocol<br />
** remove the 'webservice/xmlrpc:use' capability for authenticated user role<br />
<br />
==See also==<br />
* [[Web_services]]<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
<br />
[[Category:Web Services]]<br />
[[Category:Mobile]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93200Using web services2011-11-02T02:07:15Z<p>Jmouneyrac: /* Adding functions to the service */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For this example, select 'Create group'.<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You should be back to the service functions list. 'Required capabilities' are indicated for each function. Users need the required capabilities to run a function. The function descriptions in the API Documentation can also give you more information about the required capabilities (''Admin > Plugins > Web services > API Documentation'').<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The service ''Required capability'' if set (''Site administration > Plugins > Web services > Manage services >'''Edit''' link'').<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.<br />
<br />
Once done, the web service should be set up. Users should be able to [[How_to_get_a_security_key|obtain a personal security key]].<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)<br />
# Select some users and click '''Add'''<br />
<br />
Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: ''IP restriction'' and ''Valid until''.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.<br />
Finally, you can note that like for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93199Using web services2011-11-02T02:02:07Z<p>Jmouneyrac: /* Adding functions to the service */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For this example, select 'Create group'.<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the function descriptions in the API Documenation (''Admin > Plugins > Web services > API Documentation'').<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The service ''Required capability'' if set (''Site administration > Plugins > Web services > Manage services >'''Edit''' link'').<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.<br />
<br />
Once done, the web service should be set up. Users should be able to [[How_to_get_a_security_key|obtain a personal security key]].<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)<br />
# Select some users and click '''Add'''<br />
<br />
Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: ''IP restriction'' and ''Valid until''.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.<br />
Finally, you can note that like for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93198Using web services2011-11-02T01:58:21Z<p>Jmouneyrac: /* Alternative settings */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The service ''Required capability'' if set (''Site administration > Plugins > Web services > Manage services >'''Edit''' link'').<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.<br />
<br />
Once done, the web service should be set up. Users should be able to [[How_to_get_a_security_key|obtain a personal security key]].<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)<br />
# Select some users and click '''Add'''<br />
<br />
Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: ''IP restriction'' and ''Valid until''.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.<br />
Finally, you can note that like for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93197Using web services2011-11-02T01:55:54Z<p>Jmouneyrac: /* Enabling capabilities */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The service ''Required capability'' if set (''Site administration > Plugins > Web services > Manage services >'''Edit''' link'').<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.<br />
<br />
Once done, the web service should be set up. Users should be able to [[How_to_get_a_security_key|obtain a personal security key]].<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)<br />
# Select some users and click '''Add'''<br />
<br />
Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93196Using web services2011-11-02T01:55:01Z<p>Jmouneyrac: /* Enabling capabilities */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The service ''Required capability'' if set (Manage Services >'''Edit''' link).<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.<br />
<br />
Once done, the web service should be set up. Users should be able to [[How_to_get_a_security_key|obtain a personal security key]].<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)<br />
# Select some users and click '''Add'''<br />
<br />
Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93195Using web services2011-11-02T01:52:26Z<p>Jmouneyrac: /* Enabling capabilities */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.<br />
<br />
Once done, the web service should be set up. Users should be able to [[How_to_get_a_security_key|obtain a personal security key]].<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)<br />
# Select some users and click '''Add'''<br />
<br />
Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93194Using web services2011-11-02T01:51:31Z<p>Jmouneyrac: /* Alternative settings */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service.<br />
<br />
Once done, the web service should be set up. Users can [[How_to_get_a_security_key|obtain a personal security key]] and copy it in an external application.<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)<br />
# Select some users and click '''Add'''<br />
<br />
Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93193Using web services2011-11-02T01:49:38Z<p>Jmouneyrac: /* Authorise only specific users */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service.<br />
<br />
Once done, the web service should be set up. Users can [[How_to_get_a_security_key|obtain a personal security key]] and copy it in an external application.<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)<br />
# Select some users and click '''Add'''<br />
<br />
Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
== Enable capabilities for the user==<br />
The last step, and the trickiest, is to grant the right permission to the external system user. It would need the following capabilities:<br />
* "''webservice/rest:use'', ''webservice/soap:use'', ''webservice/xmlrpc:use'', ''webservice/amf:use''" matching the enabled protocols.<br />
* the required capabilities by the web service functions. These required capabilities are listed when you add a function to the service.<br />
As you previously created a token for the external system user, you do not need to assign "''moodle/webservice:createtoken''" to it.<br />
For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93192Using web services2011-11-02T01:48:43Z<p>Jmouneyrac: /* Authorise only specific users */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service.<br />
<br />
Once done, the web service should be set up. Users can [[How_to_get_a_security_key|obtain a personal security key]] and copy it in an external application.<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)<br />
# Select the created user and click '''Add'''<br />
<br />
As you can see in the second screen capture, Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
== Enable capabilities for the user==<br />
The last step, and the trickiest, is to grant the right permission to the external system user. It would need the following capabilities:<br />
* "''webservice/rest:use'', ''webservice/soap:use'', ''webservice/xmlrpc:use'', ''webservice/amf:use''" matching the enabled protocols.<br />
* the required capabilities by the web service functions. These required capabilities are listed when you add a function to the service.<br />
As you previously created a token for the external system user, you do not need to assign "''moodle/webservice:createtoken''" to it.<br />
For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93191Using web services2011-11-02T01:48:26Z<p>Jmouneyrac: /* Authorise only specific users */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service.<br />
<br />
Once done, the web service should be set up. Users can [[How_to_get_a_security_key|obtain a personal security key]] and copy it in an external application.<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link (the service must have been set as 'Authorised users only' in the 'Edit' link)<br />
# Select the created user and click '''Add'''<br />
<br />
As you can see in the second screen capture, Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
== Enable capabilities for the user==<br />
The last step, and the trickiest, is to grant the right permission to the external system user. It would need the following capabilities:<br />
* "''webservice/rest:use'', ''webservice/soap:use'', ''webservice/xmlrpc:use'', ''webservice/amf:use''" matching the enabled protocols.<br />
* the required capabilities by the web service functions. These required capabilities are listed when you add a function to the service.<br />
As you previously created a token for the external system user, you do not need to assign "''moodle/webservice:createtoken''" to it.<br />
For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93190Using web services2011-11-02T01:45:36Z<p>Jmouneyrac: /* Creating a service */</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service.<br />
<br />
Once done, the web service should be set up. Users can [[How_to_get_a_security_key|obtain a personal security key]] and copy it in an external application.<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link<br />
# Select the created user and click '''Add'''<br />
<br />
As you can see in the second screen capture, Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
== Enable capabilities for the user==<br />
The last step, and the trickiest, is to grant the right permission to the external system user. It would need the following capabilities:<br />
* "''webservice/rest:use'', ''webservice/soap:use'', ''webservice/xmlrpc:use'', ''webservice/amf:use''" matching the enabled protocols.<br />
* the required capabilities by the web service functions. These required capabilities are listed when you add a function to the service.<br />
As you previously created a token for the external system user, you do not need to assign "''moodle/webservice:createtoken''" to it.<br />
For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93189Web services2011-11-02T01:18:29Z<p>Jmouneyrac: </p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
=== How it works ===<br />
This simple example will give you an idea of how our web services infrastructure works. <br />
#The client sends a username and password to the web service login script.<br />
#The script returns a token for that user account.<br />
#The client calls a particular web service function on a protocol server including the token .<br />
#The protocol server uses the token to check that the user can call the function.<br />
#The protocol server call the matching external function, located in a externallib.php file inside the relevant module.<br />
#The external function checks that the current user has_capability to do this operation.<br />
#The external function calls the matching Moodle core function (in lib.php usually).<br />
#The core function can return a result to the external function. <br />
#The external function will return a result to the protocol server.<br />
#The protocol server returns the result to the client.<br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
== Developer documentation==<br />
The full API can be founnd on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.<br />
<br />
* [[Development:Creating a web service and a web service function | Implement a web service and a web service function]]<br />
* [[Development:Creating a web service client | Implement a web service client]]<br />
* [https://docs.moodle.org/dev/Web_services_Roadmap Web service Roadmap]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Specification / core development:<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93187Web services2011-11-01T10:41:05Z<p>Jmouneyrac: </p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
=== How it works ===<br />
This simple example will give you an idea of how our web services infrastructure works. <br />
#The client sends a username and password to the web service login script.<br />
#The script returns a token for that user account.<br />
#The client calls a particular web service function on a protocol server including the token .<br />
#The protocol server uses the token to check that the web service session is still active.<br />
#The protocol server call the matching external function, located in a externallib.php file inside the relevant module.<br />
#The external function checks that the current user has_capability to do this operation.<br />
#The external function calls the matching Moodle core function (in lib.php usually).<br />
#The core function can return a result to the external function. <br />
#The external function will return a result to the protocol server.<br />
#The protocol server returns the result to the client.<br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
== Developer documentation==<br />
The full API can be founnd on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.<br />
<br />
* [[Development:Creating a web service and a web service function | Implement a web service and a web service function]]<br />
* [[Development:Creating a web service client | Implement a web service client]]<br />
* [https://docs.moodle.org/dev/Web_services_Roadmap Web service Roadmap]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Specification / core development:<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93186Web services2011-11-01T10:29:36Z<p>Jmouneyrac: /* User documentation */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
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.<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
== Developer documentation==<br />
The full API can be founnd on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.<br />
<br />
* [[Development:Creating a web service and a web service function | Implement a web service and a web service function]]<br />
* [[Development:Creating a web service client | Implement a web service client]]<br />
* [https://docs.moodle.org/dev/Web_services_Roadmap Web service Roadmap]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Specification / core development:<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93185Using web services2011-11-01T10:16:34Z<p>Jmouneyrac: </p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
There are no default web services in Moodle so it is necessary to create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service.<br />
<br />
Once done, the web service should be set up. Users can [[How_to_get_a_security_key|obtain a personal security key]] and copy it in an external application.<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link<br />
# Select the created user and click '''Add'''<br />
<br />
As you can see in the second screen capture, Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
== Enable capabilities for the user==<br />
The last step, and the trickiest, is to grant the right permission to the external system user. It would need the following capabilities:<br />
* "''webservice/rest:use'', ''webservice/soap:use'', ''webservice/xmlrpc:use'', ''webservice/amf:use''" matching the enabled protocols.<br />
* the required capabilities by the web service functions. These required capabilities are listed when you add a function to the service.<br />
As you previously created a token for the external system user, you do not need to assign "''moodle/webservice:createtoken''" to it.<br />
For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93184Using web services2011-11-01T10:16:02Z<p>Jmouneyrac: </p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service. Each user will normally enter their own security key into an external application.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
There are no default web services in Moodle so it is necessary to create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service.<br />
<br />
Once done, the web service should be set up. Users can [[How_to_get_a_security_key|obtain a personal security key]] and copy it in an external application.<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link<br />
# Select the created user and click '''Add'''<br />
<br />
As you can see in the second screen capture, Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
== Enable capabilities for the user==<br />
The last step, and the trickiest, is to grant the right permission to the external system user. It would need the following capabilities:<br />
* "''webservice/rest:use'', ''webservice/soap:use'', ''webservice/xmlrpc:use'', ''webservice/amf:use''" matching the enabled protocols.<br />
* the required capabilities by the web service functions. These required capabilities are listed when you add a function to the service.<br />
As you previously created a token for the external system user, you do not need to assign "''moodle/webservice:createtoken''" to it.<br />
For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93183Web services2011-11-01T10:13:49Z<p>Jmouneyrac: /* Developer documentation */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
== Developer documentation==<br />
The full API can be founnd on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.<br />
<br />
* [[Development:Creating a web service and a web service function | Implement a web service and a web service function]]<br />
* [[Development:Creating a web service client | Implement a web service client]]<br />
* [https://docs.moodle.org/dev/Web_services_Roadmap Web service Roadmap]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Specification / core development:<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93182Web services2011-11-01T10:09:20Z<p>Jmouneyrac: /* Administrator documentation */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
== Administrator documentation ==<br />
* [[How_to_create_and_enable_a_web_service|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
== Developer documentation==<br />
The full API can be founnd on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.<br />
<br />
* [[Development:Creating a web service and a web service function]]<br />
* [[Development:Creating a web service client]]<br />
* [https://docs.moodle.org/dev/Web_services_Roadmap Web service Roadmap]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Specification / core development:<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services_for_ordinary_users&diff=93181Web services for ordinary users2011-11-01T10:08:32Z<p>Jmouneyrac: moved Web services for ordinary users to How to create and enable a web service</p>
<hr />
<div>#REDIRECT [[How to create and enable a web service]]</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Using_web_services&diff=93180Using web services2011-11-01T10:08:32Z<p>Jmouneyrac: moved Web services for ordinary users to How to create and enable a web service</p>
<hr />
<div>{{Web services}}<br />
This document explains how an administrator can set up a web service for users to access a service. All users will have a specific and unique security key (also known as a "token") to access the service. Each user will normally enter their own security key into an external application.<br />
<br />
== Enabling web services==<br />
[[Image:Enable_web_service.jpg|thumb|Enabling web services]]<br />
# Access ''Settings > Site administration > Advanced features''<br />
# Check 'Enable web services' then click 'Save Changes'<br />
<br />
Note: For security reasons, web services should only be enabled if you intend to make use of it.<br />
<br />
== Enabling protocols ==<br />
[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]<br />
Usually external applications that users wish to use dictate which protocols should be enabled. <br />
<br />
# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''<br />
# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required<br />
<br />
== Enabling web service function documentation ==<br />
[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]<br />
Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[How_to_get_a_security_key|security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.<br />
<br />
== Creating a service ==<br />
There are no default web services in Moodle so it is necessary to create a custom service i.e. select which of the standard web service functions are available via that service.<br />
<br />
You can enable only the specific functions that you need to expose, so not compromising on security.<br />
[[Image:Create a service.jpg|thumb|Creating a service|left]]<br />
# Access ''Settings > Site administration > Plugins > Web services > External services''<br />
# Click Add new custom service<br />
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed<br />
#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)<br />
# Enter a name and check Enabled<br />
# Click the button 'Add service'<br />
<br />
==Adding functions to the service==<br />
[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For now, select 'Create group' as it is the function used as an example in [[Development:Creating_a_web_service_client|Creating a web service client]].<br />
<br />
# Click 'Add functions' link<br />
# Select 'create group' function and click the 'Add functions' button<br />
<br />
You will then be returned to the service functions list. Opposite each function is a 'Required capabilities' field. Users need these capabilities to run each function. However there are exceptions - see the web service function documentation for details.<br />
<br />
==Enabling capabilities==<br />
<br />
The final step is to grant appropriate permissions. The following capabilities should be allowed:<br />
<br />
* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key<br />
* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.<br />
* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service.<br />
<br />
Once done, the web service should be set up. Users can [[How_to_get_a_security_key|obtain a personal security key]] and copy it in an external application.<br />
<br />
= Alternative settings = <br />
<br />
== Authorise only specific users==<br />
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]<br />
# ''Settings > Site Administration > Plugins > Web services > External Services''<br />
# Select '''Authorised users''' link<br />
# Select the created user and click '''Add'''<br />
<br />
As you can see in the second screen capture, Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user you can setup some specific options: IP restriction and Valid until.<br />
<br />
== Create a token ==<br />
[[Image:Create_token.jpg|thumb]]<br />
This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security keys page.<br />
<br />
# ''Settings > Site Administration > Plugins > Web services > Manage tokens''<br />
# Click on '''Add'''<br />
# Select the created user and service<br />
# Click on '''Saves changes'''<br />
<br />
== Enable capabilities for the user==<br />
The last step, and the trickiest, is to grant the right permission to the external system user. It would need the following capabilities:<br />
* "''webservice/rest:use'', ''webservice/soap:use'', ''webservice/xmlrpc:use'', ''webservice/amf:use''" matching the enabled protocols.<br />
* the required capabilities by the web service functions. These required capabilities are listed when you add a function to the service.<br />
As you previously created a token for the external system user, you do not need to assign "''moodle/webservice:createtoken''" to it.<br />
For more information about roles and capabilities, read the [https://docs.moodle.org/en/Manage_roles Manage roles] documentation.</div>Jmouneyrachttps://docs.moodle.org/24/en/index.php?title=Web_services&diff=93179Web services2011-11-01T10:07:01Z<p>Jmouneyrac: /* Administrator documentation */</p>
<hr />
<div>{{Managing a Moodle site}}<br />
Web services enable other systems to login to Moodle and perform operations. <br />
<br />
== Administrator documentation ==<br />
* [[Web services for ordinary users|How to create and enable a web service]]<br />
* [[Enable mobile web services|How to enable the mobile web service]]<br />
<br />
== User documentation ==<br />
* [[Security keys|How to obtain a security key (token)]]<br />
<br />
== Developer documentation==<br />
The full API can be founnd on any Moodle sites under ''' Administration block > Plugins > Web services > API Documentation'''.<br />
<br />
* [[Development:Creating a web service and a web service function]]<br />
* [[Development:Creating a web service client]]<br />
* [https://docs.moodle.org/dev/Web_services_Roadmap Web service Roadmap]<br />
<br />
==See also==<br />
Sharing knowledge:<br />
* The official discussion [http://moodle.org/mod/forum/view.php?id=6971| forum is here]<br />
* [[Web_services_FAQ|Web services FAQ]]<br />
<br />
Specification / core development:<br />
* [[Development:External services security]]<br />
* [[Development:External services description]]<br />
<br />
Other implementations:<br />
* [[:dev:Web_Services:OK_Tech_Web_Services|OK Tech Web Services]]<br />
<br />
[[Category:Web Services]]<br />
<br />
[[eu:Web-zerbitzuak]]<br />
[[ja:ウェブサービス]]</div>Jmouneyrac