Webservices FAQ - Versionsgeschichte

Ghillenb am 13. Juni 2012 um 19:50 Uhr

2012-06-13T19:50:15Z

← Nächstältere Version		Version vom 13. Juni 2012, 19:50 Uhr
Zeile 1:		Zeile 1:
	{{Webservices}}		{{Webservices}}

	~~{{Zum Übersetzen}}~~
	Dieser Artikel gibt Antwort auf einige häufig gestellte Fragen aus dem [http://moodle.org/mod/forum/view.php?id=6971 Web Services Forum] auf moodle.org.		Dieser Artikel gibt Antwort auf einige häufig gestellte Fragen aus dem [http://moodle.org/mod/forum/view.php?id=6971 Web Services Forum] auf moodle.org.

Ghillenb: /* Was bedeutet die Fehlermeldung Access control exception? */

2012-06-13T19:49:58Z

Was bedeutet die Fehlermeldung Access control exception?

← Nächstältere Version		Version vom 13. Juni 2012, 19:49 Uhr
Zeile 52:		Zeile 52:

	== Was bedeutet die Fehlermeldung ''Access control exception''? ==		== Was bedeutet die Fehlermeldung ''Access control exception''? ==
	~~It means that one of this admin setting has failed~~:		Das bedeutet, dass eine der folgenden Einstellungen einen Fehler verursacht:
	* ~~authorised user~~: ~~ip restriction fails to authenticate the user~~ (Administration > Plugins > ~~Web services~~ > ~~Manage services~~ > ~~Authorized users > click on user full name~~)		* autorisierte Nutzer/innen: die IP-Beschränkung kann den Nutzer nicht authentifizieren (''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > Externe Services > Autoriserte Nutzer/innen'': Nutzername anklicken).
	* ~~authorised user~~: ~~valid date is expired~~ (Administration > Plugins > ~~Web services~~ > ~~Manage services~~ > ~~Authorized users > click on user full name~~)		* autorisierte Nutzer/innen: das Gültigkeitsdatum ist abgelaufen (''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > Externe Services > Autorisierte Nutzer/innen'': Nutzername anklicken).
	* ~~admin created the token~~: ~~ip restriction fails to authenticate the user~~ (Administration > Plugins > ~~Web services~~ > ~~Manage tokens > check the status~~)		* der Admin hat das Token generiert: die IP-Beschränkung kann den Nutzer nicht authentifizieren (''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > Tokens verwalten'': Status prüfen).
	* ~~admin created the token~~: ~~valid date is expired~~ (Administration > Plugins > ~~Web services~~ > ~~Manage tokens > check the status~~)		* der Admin hat das Token generiert: das Gültigkeitsdatum ist abgelaufen (''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > Tokens verwalten'': Status prüfen).
	* ~~the user is not listed~~ in ~~the authorized list (~~Administration > Plugins > ~~Web services~~ > ~~Manage services~~ > ~~Authorized users)~~		* Der/die Nutzer/in ist nicht in der Liste der autorisierten Nutzer/innen enthalten: ''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > Externe Services > Autorisierte Nutzer/innen''.
	* ~~the user hasn~~'~~t the required capability (~~Administration > Plugins > ~~Web services~~ > ~~Manage services > Edit service)~~		* Der/die Nutzer/in hat nicht das erforderliche Recht: ''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > Externe Services'': Service bearbeiten.
	* ~~site in maintenance mode~~		* Die Moodle-Site ist im [[Wartungsmodus]].
	* ~~user is suspended~~		* Das Nutzerkonto ist gesperrt.
	* ~~user is not confirmed~~		* Das Nutzerkonto ist nicht bestätigt.
	* ~~user is deleted~~		* das Nutzerkonto ist gelöscht.
	* ~~the user authentication is set to nologin (edit the user profile)~~		* Die Authentifizierungsmethode für das Nutzerkonto ist auf ''Kein Login'' geetzt
	* ~~password expired~~ (~~most likely happens with external authentication like~~ LDAP)		* Das Kennwort ist abgelaufen (am wahrscheinlichsten bei externen Authentifizierungsmethoden, z.B. über einen [[LDAP-Server]]).
	* ~~web service disabled~~ (Administration > ~~Advanced features~~)		* Webservics sind deaktiviert (''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Zusatzoptionen'').
	* ~~user doesn't have the capability to use the used web service protocol~~ (~~user should have the capability '~~webservice/use:xmlrpc'/'webservice/use:rest'/.~~.., on SYSTEM context~~).		* Der/die Nutzer/in hat nicht das Recht, das Webservice-Protokoll zu verwenden (die Fähigkeiten [[Capabilities/webservice/use:xmlrpc]], [[Capabilitie/webservice/use:rest]], Capabilities/webservice/use:soap]] bzw. [[Capabilities/webservice/use:amf]] müssen im System-Kontext auf ''erlauben'' gesetzt sein).
	* ~~the user token doesn't exist~~		* Das Nutzer-Token existiert nicht.
	* ~~the web service function is not included in the service~~		* Die Webservice-Funktion ist nicht zum Service hinzugefügt.

	~~Since Moodle 2.2~~, ~~if the administrator turns Moodle debug mode >= NORMAL, then an explicit error message will be returned~~.		Wenn Sie als Administrator/in den [[Debugging\|Debug-Modus]] aktivieren, erhalten Sie detailliertere Fehlerinformationen.

	==Siehe auch==		==Siehe auch==

Ghillenb: /* Wie kann ich einen Webservice aufsetzen? */

2012-06-13T18:46:19Z

Wie kann ich einen Webservice aufsetzen?

← Nächstältere Version		Version vom 13. Juni 2012, 18:46 Uhr
Zeile 41:		Zeile 41:
	== Wie kann ich einen Webservice aufsetzen? ==		== Wie kann ich einen Webservice aufsetzen? ==

	* Siehe [[Webservices nutzen~~]]the document [[How_to_create_and_enable_a_web_service\| How to create and enable a web service~~]].		* Siehe [[Webservices nutzen]].
	* Auf der Seite ''''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > Übersicht'' finden Sie zwei Anwendungsbeispiele.		* Auf der Seite ''''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > Übersicht'' finden Sie zwei Anwendungsbeispiele.
	* Wenn Sie Fragen haben, nutzen Sie das [http://moodle.org/mod/forum/view.php?id=6971 Webservices Forum] auf moodle.org.		* Wenn Sie Fragen haben, nutzen Sie das [http://moodle.org/mod/forum/view.php?id=6971 Webservices Forum] auf moodle.org.

Ghillenb am 13. Juni 2012 um 18:45 Uhr

2012-06-13T18:45:57Z

← Nächstältere Version		Version vom 13. Juni 2012, 18:45 Uhr
Zeile 2:		Zeile 2:

	{{Zum Übersetzen}}		{{Zum Übersetzen}}
	~~This document lists some popular questions from the~~ [http://moodle.org/mod/forum/view.php?id=6971 Web Services ~~forum~~].		Dieser Artikel gibt Antwort auf einige häufig gestellte Fragen aus dem [http://moodle.org/mod/forum/view.php?id=6971 Web Services Forum] auf moodle.org.

	~~== What is the difference between web services and MNet ==~~

	~~[[MNet]] is used to authenticate some users from a Moodle A site into a Moodle B site.~~

	~~Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).~~		== Was ist der Unterschied zwischen einem Webservice und MNet? ==

	~~== I see the term "Web services" used~~ in ~~different ways, what does it mean? ==~~		[[MNet]] wird verwendet, um Nutzer/innen einer Moodle-Site '''A''' in einer Moodle-Site '''B''' zu authentifizieren.

	~~# The entire system~~ in Moodle ~~is referred to as the Moodle Web Service system.~~		Webservices sind Funktionen, die von externen Applikationen in Moodle aufgerufen werden (über SOAP, XML-RPC, REST oder AMF).
	~~# A particular action~~ (~~like creating a user~~) ~~is known as a Web service '''function'''.~~
	~~# The admin can enable groups of these functions for outside use, and these are known as a "Web service"~~.

	== ~~Where is the Web Service API documented~~? ==		== Der Begriff "Webservices" wird in verschiedenen Zusammenhängen verwendet, was bedeutet er? ==

	~~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~~.		# Das gesamte Webservices-System in Moodle wird als Moodle-Webservice-System bezeichnet.
			# Eine einzelne Aktion (z.B. das Anlegen eines Nutzers) wird als Webservice-Funktion bezeichnet.
			# Als Administrator/in können Sie mehrere dieser Funktionen für die Verwendung "von außen" aktivieren, und diese Funktionen werden als "Webservice" bezeichnet.

	~~'''Full~~ API ~~documentation'''~~		== Wo ist die Webservice API dokumentiert? ==
	~~# Connect as admin~~		Da verschiedene Moodle-Sites die API erweitern oder einschränken können, ändert sich die API im Laufe der Zeit. Die beste Möglichkeit, die genaue API für eine spezielle Moodle-Site zu sehen, ist, sich die automatisch generierte Dokumentation anzusehen.
	~~# Go to Administration Settings block > Plugins > Web services >~~ API ~~documentation~~

	'''~~Specific documentation to a user~~'''		'''Vollständige API Dokumentation'''
	# ~~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]]~~.		# Melden Sie sich als Administrator/in an.
	# ~~connect as non admin, and access the service documentation on your~~ [[~~How_to_get_a_security_key~~\|~~security keys page~~]].		# Gehen Sie auf die Seite ''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > API Dokumentation''.

	~~== Why are there not many functions~~ in ~~the API? ==~~		'''Spezifische Dokumentation für Nutzer/innen'''
			# Melden Sie sich als Administrator/in an, aktivieren Sie [[Webservices]] als Zusatzoption, legen Sie einen Webservice an und fügen Sie einige Moodle-Funktionen zu diesem Service hinzu, siehe [[Webservices nutzen]].
			# Melden Sie sich als Nicht-Admin an und gehen Sie auf Ihre [[Sicherheitsschlüssel]]-Seite.

	~~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~~).		== Warum gibt es in der API nur wenige Funktionen? ==
			Wir sind sehr vorsichtig mit dem Hinzufügen von Funktionen, weil wir die API der Funktionen möglichst nicht ändern möchten, sobald sie einmal implementiert sind. Die Funktionen, die es in Moodle 2 gibt, waren die am meisten geforderten (für Nutzer/innen, Kurse, Gruppen und Einschreibungen).

	~~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~~]].		Mit der Zeit werden wir weitere Funktionen hinzufügen, basiert auf die Beiträge der Community und gestellte Anforderungen. Siehe [[:dev:Web_services_Roadmap\|Webservices Roadmap]].

	~~You can also extend the~~ API ~~on your own~~ Moodle ~~site by creating your own~~ API ~~functions~~ (~~see next question~~).		Sie können auch die API in Ihrer eigenen Moodle-Site erweitern, indem Sie eigene API-Funktionen implementieren (siehe nächste Frage).

	== ~~How can I create~~ a ~~new~~ web service function~~? ==~~		== Wie kann ich eine neue Webservice-Funktion implementieren? ==
			Der einfachste und empfohlene Weg ist es, ein neues lokales Moodle-Plugin zu entwickeln und die Webservice-Funktionen dort zu implementieren. Die Moodle-Administration muss dieses Plugin dann nur in Moodle installieren (im Verzeichnis ''/moodle/local/''), die Webservice-Funktionen werden automatisch angelegt. Weitere Informationen zur Plugin-Entwicklung finden Sie in der Datei ''/moodle/local/readme.txt''. Lesen Sie außerdem die Entwickler-Dokumentation, siehe [[:dev:Creating_a_web_service_and_a_web_service_function\|how to implement a web service and a web service function]].

	The easiest and recommended way to add a web service is to write a new Moodle local plugin and to implement the web service functions there. The Moodle administrator will just need to add the plugin in Moodle (copy the files in /local/), the web service functions will be automatically added. Please read /local/readme.txt for more information about plugin development. Finally read [[:dev:Creating_a_web_service_and_a_web_service_function\|how to implement a web service and a web service function]].		== Wie kann ich einen Webservice aufsetzen? ==

	== How ~~can I set up~~ a web service? ==		* Siehe [[Webservices nutzen]]the document [[How_to_create_and_enable_a_web_service\| How to create and enable a web service]].
			* Auf der Seite ''''[[Einstellungen-Block\|Einstellungen]] > Website-Administration > Plugins > Webservices > Übersicht'' finden Sie zwei Anwendungsbeispiele.
			* Wenn Sie Fragen haben, nutzen Sie das [http://moodle.org/mod/forum/view.php?id=6971 Webservices Forum] auf moodle.org.

	* See the document [[How_to_create_and_enable_a_web_service\| How to create and enable a web service]].		== Arbeitet der Moodle SOAP Server mit JAVA oder .NET? ==
	* ''Settings > Site administration > Plugins > Web services > Overview'' explains two use cases.		Leider ist das generierte WSDL momentan nicht kompatibel mit JAVA oder .NET. Siehe MDL-28988 und MDL-28989 für Pläne, ein JAVA-kompatibles SOAP WSDL zu generieren.
	* Finally ask questions on the [http://moodle.~~org/mod/forum/view~~.~~php?id=6971 Web Services forum]~~

	== ~~Does the Moodle SOAP server work with JAVA or .NET~~? ==		== Wie bekomme ich ein Nutzer-Token von einer externen Applikation? ==
			Nutzen Sie das PHP-Skript ''/moodle/login/token.php'', siehe Entwickler-Dokumentation [[:dev:Creating_a_web_service_client#How_to_get_a_user_token\|How to get a user token]].

	~~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.~~		== Was bedeutet die Fehlermeldung ''Access control exception''? ==

	== ~~How to get a user token from an external application? ==~~
	~~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]]~~

	~~== What is the~~ 'Access control exception' ~~error~~ ==
	It means that one of this admin setting has failed:		It means that one of this admin setting has failed:
	* authorised user: ip restriction fails to authenticate the user (Administration > Plugins > Web services > Manage services > Authorized users > click on user full name)		* authorised user: ip restriction fails to authenticate the user (Administration > Plugins > Web services > Manage services > Authorized users > click on user full name)
Zeile 74:		Zeile 72:
	Since Moodle 2.2, if the administrator turns Moodle debug mode >= NORMAL, then an explicit error message will be returned.		Since Moodle 2.2, if the administrator turns Moodle debug mode >= NORMAL, then an explicit error message will be returned.

	==~~See also~~==		==Siehe auch==

	* ~~Using Moodle~~ [http://moodle.org/mod/forum/view.php?id=6971 ~~Web Services forum~~]		* [http://moodle.org/mod/forum/view.php?id=6971 Webservices Forum] - Diskussionsforum im Kurs ''Using Moodle'' auf moodle.org

	[[Category:Moodle-Netzwerk]]		[[Category:Moodle-Netzwerk]]

Ghillenb: Die Seite wurde neu angelegt: „{{Webservices}} {{Zum Übersetzen}} This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]. == Wh…“

2012-06-13T15:52:54Z

Die Seite wurde neu angelegt: „{{Webservices}} {{Zum Übersetzen}} This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]. == Wh…“

Neue Seite

{{Webservices}}

{{Zum Übersetzen}}
This document lists some popular questions from the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum].

== What is the difference between web services and MNet ==

[[MNet]] is used to authenticate some users from a Moodle A site into a Moodle B site.

Web services are functions that can be called by external applications (via SOAP, XML-RPC, REST or AMF).

== I see the term "Web services" used in different ways, what does it mean? ==

# The entire system in Moodle is referred to as the Moodle Web Service system.
# A particular action (like creating a user) is known as a Web service '''function'''.
# The admin can enable groups of these functions for outside use, and these are known as a "Web service".

== Where is the Web Service API documented? ==

Since different Moodle sites can extend or restrict the API, and the API will evolve over time, the best way to see the exact API for a particular Moodle site is to look at the automatically generated documentation.

'''Full API documentation'''
# Connect as admin
# Go to Administration Settings block > Plugins > Web services > API documentation

'''Specific documentation to a user'''
# Connect as admin, enable web service, create a service and add some Moodle functions to it. Also see [[How_to_create_and_enable_a_web_service]].
# connect as non admin, and access the service documentation on your [[How_to_get_a_security_key|security keys page]].

== Why are there not many functions in the API? ==

We have been very careful when adding new functions because we don't want to be changing the API functions once they are implemented. The ones we have in Moodle 2.0 are the most commonly requested ones (for users, courses, groups and enrolments).

We will add more functions to core over time, based on contributions from the community and feature requests. See the [[:dev:Web_services_Roadmap|web service roadmap]].

You can also extend the API on your own Moodle site by creating your own API functions (see next question).

== How can I create a new web service function? ==

The easiest and recommended way to add a web service is to write a new Moodle local plugin and to implement the web service functions there. The Moodle administrator will just need to add the plugin in Moodle (copy the files in /local/), the web service functions will be automatically added. Please read /local/readme.txt for more information about plugin development. Finally read [[:dev:Creating_a_web_service_and_a_web_service_function|how to implement a web service and a web service function]].

== How can I set up a web service? ==

* See the document [[How_to_create_and_enable_a_web_service| How to create and enable a web service]].
* ''Settings > Site administration > Plugins > Web services > Overview'' explains two use cases.
* Finally ask questions on the [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]

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

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.

== How to get a user token from an external application? ==
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]]

== What is the 'Access control exception' error ==
It means that one of this admin setting has failed:
* authorised user: ip restriction fails to authenticate the user (Administration > Plugins > Web services > Manage services > Authorized users > click on user full name)
* authorised user: valid date is expired (Administration > Plugins > Web services > Manage services > Authorized users > click on user full name)
* admin created the token: ip restriction fails to authenticate the user (Administration > Plugins > Web services > Manage tokens > check the status)
* admin created the token: valid date is expired (Administration > Plugins > Web services > Manage tokens > check the status)
* the user is not listed in the authorized list (Administration > Plugins > Web services > Manage services > Authorized users)
* the user hasn't the required capability (Administration > Plugins > Web services > Manage services > Edit service)
* site in maintenance mode
* user is suspended
* user is not confirmed
* user is deleted
* the user authentication is set to nologin (edit the user profile)
* password expired (most likely happens with external authentication like LDAP)
* web service disabled (Administration > Advanced features)
* user doesn't have the capability to use the used web service protocol (user should have the capability 'webservice/use:xmlrpc'/'webservice/use:rest'/..., on SYSTEM context).
* the user token doesn't exist
* the web service function is not included in the service

Since Moodle 2.2, if the administrator turns Moodle debug mode >= NORMAL, then an explicit error message will be returned.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=6971 Web Services forum]

[[Category:Moodle-Netzwerk]]
[[Category:FAQ]]

[[en:Web services FAQ]]