Hinweis: Sie sind auf den Seiten der Moodle 2.5 Dokumentation. Die Dokumentation der aktuellsten Moodle-Version finden Sie hier: Webservices nutzen.

Webservices nutzen: Unterschied zwischen den Versionen

Aus MoodleDocs
Wechseln zu:Navigation, Suche
(Die Seite wurde neu angelegt: „{{Webservices}} Dieser Artikel erklärt, wie Sie als Administrator/in einen Webservice aufsetzen. Jede/r Nutzer/in erhält einen einmaligen [[Sicherheitsschlüss…“)
 
 
(10 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 5: Zeile 5:


== Webservices aktivieren==
== Webservices aktivieren==
# Gehen Sie auf die Seite ''[[Einstellungen-Block|Einstellungen > Website-Administration > Zusatzoptionen''.
# Gehen Sie auf die Seite ''[[Einstellungen-Block|Einstellungen]] > Website-Administration > Zusatzoptionen''.
# Markieren Sie die Checkbox ''Webservices'' und klicken Sie auf den Button ''Änderungen speichern''.
# Markieren Sie die Checkbox ''Webservices'' und klicken Sie auf den Button ''Änderungen speichern''.


'''Hinweis''': Aus Sicherheitsgründen sollten Sie Webservices nur dann aktivieren, wenn Sie sie wirklich nutzen wollen.
'''Hinweis''': Aus Sicherheitsgründen sollten Sie Webservices nur dann aktivieren, wenn Sie sie wirklich nutzen wollen.
bitte die einstellungen in moodle hinzufügen!!!!! danke im voraus


== Protokolle aktivieren ==
== Protokolle aktivieren ==
Normalerweise bestimmen die externen Applikationen, welches Protokoll aktiviert werden muss.
Normalerweise bestimmen die externen Applikationen, welches Protokoll aktiviert werden muss.
# Gehen Sie auf die Seite ''[[Einstellungen-Block|Einstellungen > Website-Administration > Plugins > Webservices > Protokolle verwalten''.
# Gehen Sie auf die Seite ''[[Einstellungen-Block|Einstellungen]] > Website-Administration > Plugins > Webservices > Protokolle verwalten''.
# Aktivieren Sie die Protokolle (SOAP, REST, XMLRPC, AMF, ...) nach Bedarf.
# Aktivieren Sie die Protokolle (SOAP, REST, XMLRPC, AMF, ...) nach Bedarf.
wo finde ich die eistellungen bitte danke


== Dokumentation zu Webservices aktivieren ==
== Dokumentation zu Webservices aktivieren ==
Markieren Sie auf der Seite ''[[Einstellungen-Block|Einstellungen > Website-Administration > Plugins > Webservices > Protokolle verwalten'' die Checkbox ''Dokumentation zu Webservices''. Dann erscheint auf Seite [[Sicherheitsschlüssel]] ein Link ''Dokumentation'' angezeigt, der zur nutzerspezifischen Webservice-Dokumentation führt. Diese Option ist für Webservice-Client-Entwickler/innen nützlich.
Markieren Sie auf der Seite ''[[Einstellungen-Block|Einstellungen]] > Website-Administration > Plugins > Webservices > Protokolle verwalten'' die Checkbox ''Dokumentation zu Webservices''. Dann erscheint auf Seite [[Sicherheitsschlüssel]] ein Link ''Dokumentation'' angezeigt, der zur nutzerspezifischen Webservice-Dokumentation führt. Diese Option ist für Webservice-Client-Entwickler/innen nützlich.


== Einen Service anlegen ==
== Einen Service anlegen ==
Wenn keiner der vorhandenen Webservices Ihren Anforderungen genügt, können Sie einen eigenen Webservice anlegen 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.
Wenn keiner der vorhandenen Webservices Ihren Anforderungen genügt, können Sie einen eigenen Webservice anlegen, d.h. Sie können auswählen, welche Stnadard-Webservice-Funktionen für Ihren Service verfügbar sein sollen.


You can enable only the specific functions that you need to expose, so not compromising on security.
Aktivieren Sie aus Sicherheitsgründen nur die Funktionen, die Sie tatsächlich benötigen.
[[Image:Create a service.jpg|thumb|Creating a service|left]]
# Access ''Settings > Site administration > Plugins > Web services > External services''
# Click Add new custom service
#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed
#* '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.)
# Enter a name and check Enabled
# Click the button 'Add service'


==Funktionen zu einem Service hinzufügen==
# Gehen Sie auf die Seite ''[[Einstellungen-Block|Einstellungen]] > Website-Administration > Plugins > Webservices > Externe Services''.
[[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'.
# Klicken Sie auf den Link ''Hinzufügen''.
#* Geben Sie dem Service einen Namen und markieren Sie die Checkbox ''Aktiviert'', um den Service zu aktivieren.
#* Wenn der Service nur für autorisierte Nutzer/innen verfügbar sein soll, markieren Sie die gleichnamige Checkbox.
#* Wählen Sie in der Liste ''erforderliche Fähigkeit'' die gewünschten Fähigkeiten/Funktionalitäten aus. Für jede Person, die auf den Webservice zugreift, wird dann geprüft, ob diese Person das entsprechende Recht in Moodle hat.
# Klicken Sie abschließend auf den Button ''Service hinzufügen''.


# Click 'Add functions' link
[[Image:webservice_konfigurieren.jpg]]
# Select 'create group' function and click the 'Add functions' button


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 (''Settings > Site administration > Plugins > Web services > API Documentation'').
==Funktionen zu einem Service hinzufügen==
Ihr Webservice stellt zunächst noch keinerlei Funktionen bereit, d.h. Sie müssen noch Funktionen hinzufügen. Welche Funktionen das sind hängt davon ab, was Ihre externe Applikation in Moodle tun soll.


==Rechte==
# Klicken Sie auf den Link ''Funktionen hinzufügen''.
# Wählen Sie die gewünschten Funktionen aus der Liste aus und klicken Sie auf den Button ''Funktionen hinzufügen''.


The final step is to grant appropriate permissions. The following capabilities should be allowed:
[[Image:webservice_funktionen.jpg]]


* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key
In der Liste der zum Webservice gehörigen Funktionen sehen Sie, welche Rechte in Moodle nötig sind (Spalte ''Notwendige Fähigkeiten''). Nutzer/innen müssen diese Rechte haben, um den Service nutzen zu können. Weitere Informationen über benötigte Rechte für die einzelnen Funktionen finden Sie in der API Dokumentation (unter ''[[Einstellungen-Block|Einstellungen]] > Website-Administration > Plugins > Webservices > API Dokumentation'').
* [[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.
* The service ''Required capability'' if set (''Settings > Site administration > Plugins > Web services > Manage services >'''Edit''' link'').
* 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 [[Manage roles]] documentation.


Once done, the web service should be set up. Users should be able to [[Security keys|obtain a personal security key]].
==Rechte==
Die folgenden Rechte müssen gewährt sein:
* [[Capabilities/moodle/webservice:createtoken|Webservice-Token erzeugen]] - um Nutzer/innen zu erlauben, einen [[Sicherheitsschlüssel]] zu generieren;
* [[Capabilities/webservice/rest:use |Webservice: Protokoll REST]], [[Capabilities/webservice/soap:use |Webservice: Protokoll SOAP]], [[Capabilities/webservice/xmlrpc:use | Webservice: Protokoll XMLRPC]], [[Capabilities/webservice/amf:use |Webservice: Protokoll AMF]], die zu den entsprechenden Protokollen gehören;
* die Rechte, die bei der Konfiguration des Webservices bei der Einstellung ''Erforderliche Fähigkeit'' ausgewählt wurden (siehe Abschnitt [[#Einen Service anlegen|Einen Service anlegen]]);
* die Rechte für die Fähigkeiten, die zu den jeweiligen Webservice-Funktionen gehören (siehe Abschnitt [[#Funktionen zu einem Service hinzufügen|Funktionen zu einem Service hinzufügen]]).


== Alternative Einstellungen ==  
== Ausgewählte Nutzer/innen autorisieren==
# Gehen Sie auf die Seite ''[[Einstellungen-Block|Einstellungen]] > Website-Administration > Plugins > Webservices > Externe Services''.
# Klicken Sie auf den Link ''Autorisierte Nutzer/innen'' (für den Webservice muss in seinen Einstellungen - Link ''Bearbeiten'' - die Option ''Nur für autorisierte Nutzer/innen'' aktiviert sein).
# Wählen Sie die gewünschten Nutzer/innen in der rechten Liste aus und klicken Sie auf ''Hinzufügen''.


== Authorise only specific users==
Moodle zeigt an, wenn bestimmte Rechte autorisierten Nutzer/innen zugewiesen werden müssen. Außerdem können Sie den Namen einer Person anklicken, um für die Person eine IP-Beschränkung und ein Gültigkeitsdatum zu konfigurieren.
[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]
# ''Settings > Site Administration > Plugins > Web services > External Services''
# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)
# Select some users and click '''Add'''


Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can set up some specific options: ''IP restriction'' and ''Valid until''.
== Ein Token erzeugen ==
Mit dieser Funktionalität können Sie ein Token für eine ausgewählte Person erzeugen. Das ist nützlich, wenn diese Person nicht das Recht hat, ein [[Capabilities/moodle/webservice:createtoken|Webservice-Token erzeugen]]. Das ist die einzige Möglichkeit, ein Token für eine/n Administrator/in zu erzeugen.
Aus Sicherheitsgründen werden Auf der Administrator-Sicherheitsschlüssel-Seite keine Tokens automatisch generiert.


== Ein Token erzeugen ==
# Gehen Sie auf die Seite ''[[Einstellungen-Block|Einstellungen]] > Website-Administration > Plugins > Webservices > Tokens verwalten''.
[[Image:Create_token.jpg|thumb]]
# Klicken Sie auf den Link ''Hinzufügen''.
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.
# Wählen Sie ein/e Nutzer/in und einen Service.
# Klicken Sie auf ''Änderungen speichern''.


# ''Settings > Site Administration > Plugins > Web services > Manage tokens''
Beachten Sie, dass Sie für autorisierte Nutzer/innen auch Einschränkungen für die IP-Adresse und ein Gültigkeitsdatum konfigurieren.
# Click on '''Add'''
# Select the created user and service
# Click on '''Saves changes'''


As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.
[[Image:token.jpg]]
Finally, note that, as for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.


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

Aktuelle Version vom 30. November 2013, 11:27 Uhr


Dieser Artikel erklärt, wie Sie als Administrator/in einen Webservice aufsetzen. Jede/r Nutzer/in erhält einen einmaligen Sicherheitsschlüssel (Token), um auf den Service zuzugreifen.


Webservices aktivieren

  1. Gehen Sie auf die Seite Einstellungen > Website-Administration > Zusatzoptionen.
  2. Markieren Sie die Checkbox Webservices und klicken Sie auf den Button Änderungen speichern.

Hinweis: Aus Sicherheitsgründen sollten Sie Webservices nur dann aktivieren, wenn Sie sie wirklich nutzen wollen.


bitte die einstellungen in moodle hinzufügen!!!!! danke im voraus

Protokolle aktivieren

Normalerweise bestimmen die externen Applikationen, welches Protokoll aktiviert werden muss.

  1. Gehen Sie auf die Seite Einstellungen > Website-Administration > Plugins > Webservices > Protokolle verwalten.
  2. Aktivieren Sie die Protokolle (SOAP, REST, XMLRPC, AMF, ...) nach Bedarf.

wo finde ich die eistellungen bitte danke

Dokumentation zu Webservices aktivieren

Markieren Sie auf der Seite Einstellungen > Website-Administration > Plugins > Webservices > Protokolle verwalten die Checkbox Dokumentation zu Webservices. Dann erscheint auf Seite Sicherheitsschlüssel ein Link Dokumentation angezeigt, der zur nutzerspezifischen Webservice-Dokumentation führt. Diese Option ist für Webservice-Client-Entwickler/innen nützlich.

Einen Service anlegen

Wenn keiner der vorhandenen Webservices Ihren Anforderungen genügt, können Sie einen eigenen Webservice anlegen, d.h. Sie können auswählen, welche Stnadard-Webservice-Funktionen für Ihren Service verfügbar sein sollen.

Aktivieren Sie aus Sicherheitsgründen nur die Funktionen, die Sie tatsächlich benötigen.

  1. Gehen Sie auf die Seite Einstellungen > Website-Administration > Plugins > Webservices > Externe Services.
  2. Klicken Sie auf den Link Hinzufügen.
    • Geben Sie dem Service einen Namen und markieren Sie die Checkbox Aktiviert, um den Service zu aktivieren.
    • Wenn der Service nur für autorisierte Nutzer/innen verfügbar sein soll, markieren Sie die gleichnamige Checkbox.
    • Wählen Sie in der Liste erforderliche Fähigkeit die gewünschten Fähigkeiten/Funktionalitäten aus. Für jede Person, die auf den Webservice zugreift, wird dann geprüft, ob diese Person das entsprechende Recht in Moodle hat.
  3. Klicken Sie abschließend auf den Button Service hinzufügen.

webservice konfigurieren.jpg

Funktionen zu einem Service hinzufügen

Ihr Webservice stellt zunächst noch keinerlei Funktionen bereit, d.h. Sie müssen noch Funktionen hinzufügen. Welche Funktionen das sind hängt davon ab, was Ihre externe Applikation in Moodle tun soll.

  1. Klicken Sie auf den Link Funktionen hinzufügen.
  2. Wählen Sie die gewünschten Funktionen aus der Liste aus und klicken Sie auf den Button Funktionen hinzufügen.

webservice funktionen.jpg

In der Liste der zum Webservice gehörigen Funktionen sehen Sie, welche Rechte in Moodle nötig sind (Spalte Notwendige Fähigkeiten). Nutzer/innen müssen diese Rechte haben, um den Service nutzen zu können. Weitere Informationen über benötigte Rechte für die einzelnen Funktionen finden Sie in der API Dokumentation (unter Einstellungen > Website-Administration > Plugins > Webservices > API Dokumentation).

Rechte

Die folgenden Rechte müssen gewährt sein:

Ausgewählte Nutzer/innen autorisieren

  1. Gehen Sie auf die Seite Einstellungen > Website-Administration > Plugins > Webservices > Externe Services.
  2. Klicken Sie auf den Link Autorisierte Nutzer/innen (für den Webservice muss in seinen Einstellungen - Link Bearbeiten - die Option Nur für autorisierte Nutzer/innen aktiviert sein).
  3. Wählen Sie die gewünschten Nutzer/innen in der rechten Liste aus und klicken Sie auf Hinzufügen.

Moodle zeigt an, wenn bestimmte Rechte autorisierten Nutzer/innen zugewiesen werden müssen. Außerdem können Sie den Namen einer Person anklicken, um für die Person eine IP-Beschränkung und ein Gültigkeitsdatum zu konfigurieren.

Ein Token erzeugen

Mit dieser Funktionalität können Sie ein Token für eine ausgewählte Person erzeugen. Das ist nützlich, wenn diese Person nicht das Recht hat, ein Webservice-Token erzeugen. Das ist die einzige Möglichkeit, ein Token für eine/n Administrator/in zu erzeugen. Aus Sicherheitsgründen werden Auf der Administrator-Sicherheitsschlüssel-Seite keine Tokens automatisch generiert.

  1. Gehen Sie auf die Seite Einstellungen > Website-Administration > Plugins > Webservices > Tokens verwalten.
  2. Klicken Sie auf den Link Hinzufügen.
  3. Wählen Sie ein/e Nutzer/in und einen Service.
  4. Klicken Sie auf Änderungen speichern.

Beachten Sie, dass Sie für autorisierte Nutzer/innen auch Einschränkungen für die IP-Adresse und ein Gültigkeitsdatum konfigurieren.

token.jpg

Siehe auch