Webservices nutzen: Unterschied zwischen den Versionen

Aus MoodleDocs
Wechseln zu:Navigation, Suche
Zeile 51: Zeile 51:
== Ausgewählte Nutzer/innen autorisieren==
== Ausgewählte Nutzer/innen autorisieren==
# Gehen Sie auf die Seite ''[[Einstellungen-Block|Einstellungen]] > Website-Administration > Plugins > Webservices > Externe Services''.
# Gehen Sie auf die Seite ''[[Einstellungen-Block|Einstellungen]] > Website-Administration > Plugins > Webservices > Externe Services''.
# Klicken Sie auf den Link ''AutSelect '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)
# 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).
# Select some users and click '''Add'''
# Wählen Sie die gewünschten Nutzer/innen in der rechten Liste aus und klicken Sie auf ''Hinzufügen''.


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''.
Moodle zeigt an, wenn bestimmte Funktionen autorisierten Nutzer/innen zugewisen 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 ==
== Ein Token erzeugen ==

Version vom 13. Juni 2012, 15:03 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.

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.

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 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.

You can enable only the specific functions that you need to expose, so not compromising on security.

Datei:Create a service.jpg
Creating a service
  1. Access Settings > Site administration > Plugins > Web services > External services
  2. 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.)
  3. Enter a name and check Enabled
  4. Click the button 'Add service'

Funktionen zu einem Service hinzufügen

Datei:Select a web service function.jpg
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'.

  1. Click 'Add functions' link
  2. 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).

Rechte

The final step is to grant appropriate permissions. The following capabilities should be allowed:

Once done, the web service should be set up. Users should be able to obtain a personal security key.

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 Funktionen autorisierten Nutzer/innen zugewisen 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