OBS/Kostenpflichtige Module/RESTServer: Unterschied zwischen den Versionen
(Die Seite wurde neu angelegt: „{{Kostenpflichtige Module}}“) |
Keine Bearbeitungszusammenfassung |
||
| (3 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
{{Kostenpflichtige Module}} | {{Kostenpflichtige Module}} | ||
=REST-Schnittstelle= | |||
{{Hinweis|Es handelt sich um ein kostenpflichtiges Modul. Die Schnittstelle muss über den OBS-Support aktiviert werden.}} | |||
Über diesen OBS-Dienst wird ein Zugriff auf beliebige Daten und Funktionen durch externe Teilnehmer ermöglicht. | |||
Menü unter '''Stammdaten''' -> '''Z Weitere Stammdaten''' -> '''REST-Server''' | |||
=Endpunkte= | |||
Ein Endpunkt besteht aus Name, Sub-URL und Version, wobei die SUB-URL optional ist. Die Kombination dieser drei Werte definiert die Adresse über die der Endpunkt erreichbar ist: | |||
http://[Hostadresse][:Port]/[Endpunkt][/Sub-URL]/[Version]<br /> | |||
Beispiele:<br /> | |||
http://www.meinserver.de/kalender/v1<br /> | |||
http://www.meinserver.de/email/mein_konto/v1.0<br /> | |||
Durch die Versionierung der Endpunkte kann eine Funktionalität geändert werden, ohne dabei den Zugriff für Konsumenten der alten Version einzuschränken. Das ist immer dann sinnvoll, wenn es viele verschiedene Konsumenmten gibt, die nicht parallel zur Änderung des Endpunktes mit angepasst werden können. | |||
=Zugänge / Authentifizierung= | |||
Der Zugriff auf den REST-Dienst wird über Zugänge ermöglicht. Ein Zugang hat einen Namen zur Identifizierung (wird auch im Protokoll so angezeigt) und einen API-Key. | |||
Der API-Key ist ein eindeutiger Schlüssel der dem Konsumenten bekannt sein muss, damit er auf eine Ressource zugreifen darf. | |||
Zur Sicherheit kann noch ein Hostname vergeben werden. Der Zugang kann dann ausschließlich über diesen Hostnamen verwendet werden. Diese Option sollte, soweit möglich, immer genutzt werden. | |||
==Berechtigung / Authorisierung== | |||
Damit ein Endpunkt über einen Zugang erreicht werden kann, muss erst die dafür nötige Berechtigung vergeben werden. Die Berechtigungen für einen Endpunkt werden über F6 in der Endpunkt-Liste verwaltet. | |||
=Bindungen= | |||
Hier werden die Netzwerkbindungen definiert, über die der REST-Dienst verfügbar sein soll. Das ist i.d.R. die interne IP des Servers auf dem der REST-Dienst betrieben wird. | |||
=Protokoll= | |||
Protokollierung aller Zugriffe und Fehler | |||
=Statistik= | |||
Statistiken über Zugriffe und Zugriffszeiten | |||
Aktuelle Version vom 26. Juli 2023, 06:57 Uhr
- A Preise aktualisieren
- C Personen übertragen
- E Kategorien verwalten
- G Kataloge verwalten
- I Merkliste übertragen
- K Varianten übertragen
- L Artikelvarianten übertragen
- M Referenzarten übertragen
- N Lagerbestände verwalten
- U Bestellungen einlesen
- V leere Passworte füllen
- W Update-Informationen zurücksetzen
- X Konfiguration
- Z Protokoll
REST-Schnittstelle
Über diesen OBS-Dienst wird ein Zugriff auf beliebige Daten und Funktionen durch externe Teilnehmer ermöglicht.
Menü unter Stammdaten -> Z Weitere Stammdaten -> REST-Server
Endpunkte
Ein Endpunkt besteht aus Name, Sub-URL und Version, wobei die SUB-URL optional ist. Die Kombination dieser drei Werte definiert die Adresse über die der Endpunkt erreichbar ist:
http://[Hostadresse][:Port]/[Endpunkt][/Sub-URL]/[Version]
Beispiele:
http://www.meinserver.de/kalender/v1
http://www.meinserver.de/email/mein_konto/v1.0
Durch die Versionierung der Endpunkte kann eine Funktionalität geändert werden, ohne dabei den Zugriff für Konsumenten der alten Version einzuschränken. Das ist immer dann sinnvoll, wenn es viele verschiedene Konsumenmten gibt, die nicht parallel zur Änderung des Endpunktes mit angepasst werden können.
Zugänge / Authentifizierung
Der Zugriff auf den REST-Dienst wird über Zugänge ermöglicht. Ein Zugang hat einen Namen zur Identifizierung (wird auch im Protokoll so angezeigt) und einen API-Key. Der API-Key ist ein eindeutiger Schlüssel der dem Konsumenten bekannt sein muss, damit er auf eine Ressource zugreifen darf.
Zur Sicherheit kann noch ein Hostname vergeben werden. Der Zugang kann dann ausschließlich über diesen Hostnamen verwendet werden. Diese Option sollte, soweit möglich, immer genutzt werden.
Berechtigung / Authorisierung
Damit ein Endpunkt über einen Zugang erreicht werden kann, muss erst die dafür nötige Berechtigung vergeben werden. Die Berechtigungen für einen Endpunkt werden über F6 in der Endpunkt-Liste verwaltet.
Bindungen
Hier werden die Netzwerkbindungen definiert, über die der REST-Dienst verfügbar sein soll. Das ist i.d.R. die interne IP des Servers auf dem der REST-Dienst betrieben wird.
Protokoll
Protokollierung aller Zugriffe und Fehler
Statistik
Statistiken über Zugriffe und Zugriffszeiten