Zum Inhalt springen

OBS/Kostenpflichtige Module/REST-Server

Aus OBS Wiki
Version vom 17. November 2026, 07:12 Uhr von MINERVA-Rademacker (Diskussion | Beiträge) (MINERVA-Rademacker verschob die Seite OBS/Kostenpflichtige Module/RESTServer nach OBS/Kostenpflichtige Module/REST-Server: Titel an Überschrift angeglichen (REST-Server, Umlaute, sprechende Beispieltitel))

REST-Server

Der REST-Server ist die universelle Schnittstelle Ihrer OBS-Installation nach außen. Webseiten, Apps, Geräte, Kundensysteme und Cloud-Dienste lesen Daten direkt aus OBS oder liefern neue Daten direkt in OBS ab. Diese Seite zeigt, was der REST-Server leistet, und führt Administratoren und Entwickler zu den passenden Unterseiten.

HINWEIS: Es handelt sich um ein kostenpflichtiges Modul. Die Schnittstelle muss über den OBS-Support aktiviert werden.

Sie erreichen das Modul über Stammdaten → Z Weitere Stammdaten → REST-Server.

Nutzen

Statt Daten zu exportieren, per Mail zu verschicken und woanders wieder einzulesen, holen sich angebundene Systeme genau die Information, die sie brauchen – in dem Moment, in dem sie sie brauchen. Was bisher nur manuell, per Datei-Import oder über Spezialschnittstellen ging, lässt sich automatisieren. Jeder Anwendungsfall wird einmal eingerichtet und läuft danach von selbst.

Technisch ist der REST-Server ein in OBS integrierter HTTPS-Dienst. Jeder Endpunkt hat eine eigene Adresse, ein eigenes Skript und eigene Berechtigungen. Die Skripte pflegen Sie direkt in OBS. Antworten liefert der Server als JSON oder als Datei. Externe Systeme erhalten keinen Zugriff auf die Datenbank. Sie sehen nur, was ein Endpunkt-Skript freigibt.

Der REST-Server ist damit ein Werkzeugkasten: Was an Daten oder Funktionen in OBS verfügbar ist, können Sie über einen Endpunkt nach außen anbieten oder von außen entgegennehmen. Die Bandbreite reicht vom einfachen Lese-Endpunkt für eine Webseite bis zur B2B-Anbindung mit getrennten Zugängen je Partner.

Was Sie damit erreichen

  • Manuelle Arbeit fällt weg. Daten fließen direkt, ohne Export, Mail und Import.
  • Weniger Fehler. Jede manuelle Übertragung ist eine Fehlerquelle weniger.
  • Neue Angebote werden möglich. Kunden- und Lieferantenportale, Self-Service und Apps greifen auf OBS zu, ohne dass Sie ein zweites System pflegen.
  • Bestehende Software bleibt. Vorhandene Anwendungen docken über den REST-Server an OBS an, in beide Richtungen.
  • Wächst mit. Ein einzelner Endpunkt für eine Webseite lässt sich zu einer kompletten Integrationsplattform ausbauen, ohne die Grundlage zu wechseln.

Anwendungsbereiche

Die folgenden Einsatzfälle sind Beispiele. Alles, was sich in einem Endpunkt-Skript abbilden lässt, kann der REST-Server bereitstellen.

HINWEIS: Ob für Ihren Anwendungsfall Entwicklungsaufwand entsteht, klärt Ihr OBS-Betreuer mit Ihnen.

Webseiten und Kundenportale

  • Live-Daten auf der eigenen Webseite: Lagerbestände, Verfügbarkeiten, Preise oder Auftragsstatus direkt aus OBS, ohne tägliche Datei-Exporte.
  • Kundenportale: Kunden sehen ihre offenen Posten, Aufträge und Lieferscheine. Jeder Kunde sieht nur seine eigenen Daten.
  • Statusseiten: Endkunden fragen den Stand einer Bestellung, eines Auftrags oder einer Reparatur über eine Nummer ab.

Mobile Anwendungen und Außendienst

  • Mobile Zeiterfassung: Mitarbeiter buchen Arbeitsbeginn, Pause und Ende am Smartphone. Die Daten landen direkt in OBS.
  • Scanner und Lagergeräte: Wareneingang, Inventur und Kommissionierung direkt in OBS, ohne zwischengeschaltete Software.
  • Außendienst-Apps: Techniker sehen ihre Aufträge, dokumentieren Einsätze, erfassen Material und laden Fotos hoch.
  • Geräte in Sekunden einrichten: Ein Zugangscode als QR-Code bringt Adresse und Zugangsdaten mit einem Scan auf das Gerät.

Anbindung von Drittsystemen

  • Webshops: Der Shop meldet Bestellungen direkt an OBS und fragt Bestände und Preise ab.
  • Buchhaltungs- und ERP-Systeme: Austausch von Belegen, Stammdaten und Buchungen in beide Richtungen.
  • CRM- und Marketing-Werkzeuge: Personendaten, Aktivitäten oder Mailing-Empfänger bleiben abgeglichen.
  • Logistikdienstleister: Versandaufträge gehen hinaus, Sendungsinformationen kommen zurück.

Automatische Rückmeldungen (WebHooks)

  • Rückruf-Adressen für Fremdsysteme: OBS legt für einen Vorgang eine Adresse an, die genau einmal gilt, z.B. für einen Bezahl- oder Versanddienst. Dessen Rückmeldung landet in OBS und wird dort weiterverarbeitet.
  • Automatisierungsplattformen stoßen über gewöhnliche Endpunkte Vorgänge in OBS an.

Geschäftspartner (B2B)

  • Lieferanten: Bestellungen gehen automatisch hinaus, Auftragsbestätigungen und Lieferavise kommen zurück.
  • Großkunden bestellen direkt aus ihrem eigenen System.
  • Maschine-zu-Maschine mit mTLS: Nur Partnersysteme mit einem gültigen Client-Zertifikat sprechen mit OBS.

Interne Automatisierungen

  • Eigene Hilfswerkzeuge für Sammelaktionen, Berichte oder zeitgesteuerte Abläufe.
  • Mehrere Standorte tauschen Daten über definierte Endpunkte aus, ohne offene Datenbankverbindungen.
  • Dashboards und BI-Werkzeuge lesen aufbereitete Kennzahlen direkt aus OBS.

Seiten in diesem Bereich

Einrichten und betreiben

Seite Wofür
Einrichtung Schritt für Schritt vom Server-Profil bis zum ersten erfolgreichen Aufruf.
Öffentliche Freigabe Portfreigabe, Reverse-Proxy, VPN und eigener Server im Vergleich.
Server-Profile TLS, mTLS, Rate-Limits, Zertifikate und Bindungen eines Server-Profils.
Zertifikatserneuerung Zertifikate automatisch beantragen und erneuern lassen.
Zugänge API-Key, Host- und CORS-Beschränkung, mTLS und JWT je Zugang.
Endpunkte Pfad-Templates, Berechtigungen, WebHooks und Skripte der Endpunkte.
Zugangscode und Zertifikats-Pin Geräte per QR-Code einrichten und den Server ohne öffentliches Zertifikat absichern.
Betrieb und Fehlersuche Protokoll, Statistik, Konsole, Reverse-Proxy und Wartung der Tabellen.

Entwickeln

Seite Wofür
HTTP-Schnittstelle Header, Ablauf einer Anfrage, Fehlerformat, Fehlercodes, Rate-Limit und Idempotenz.
Anmeldung mit JWT Anmelden, Token erneuern, Abmelden und das Anmeldeskript.
Scripting Aufbau der Endpunkt-Skripte mit Reader und Writer.
Datei-Upload Dateien entgegennehmen, auch fortsetzbar in Teilstücken.
Datei-Download Dateien ausliefern, auch in Teilen.

Beispiele

Seite Wofür
Beispiel 1: Daten-Abruf mit JWT Daten aus OBS auf einer Webseite anzeigen, mit Anmeldung.
Beispiel 3: Datensatz anlegen mit JSON-Body Datensätze eines Fremdsystems anlegen, abrufen und ändern.
Beispiel 4: Pfad-Parameter Einzelne Datensätze über Platzhalter im Pfad ansprechen.
Beispiel 5: Schreibzugriff mit Statuscodes, ETag und Idempotenz Sicher schreiben aus einer mobilen App.
Beispiel 6: Datei-Upload und Ablage Fotos und Dokumente zu einem Vorgang hochladen und ablegen.

Grundlagen

Bausteine

Alle Bausteine pflegen Sie in OBS. Jeder Baustein hat eine eigene Tabelle.

Baustein Tabelle Zweck
Server-Profil RESTSRV_SERVER TLS-Einstellungen und Grenzen eines eigenen HTTP-Servers. Mehrere Profile sind möglich.
Bindung RESTSRV_BINDINGS IP-Adresse und Port, auf denen ein Server-Profil lauscht.
Zugang RESTSRV_ACCOUNT API-Key, optionale Host- und CORS-Beschränkung, mTLS und JWT-Anmeldung.
Endpunkt RESTSRV_ENDPOINTS Pfad-Template und Skript. Einem Server-Profil fest zugeordnet.
Berechtigung RESTSRV_ACCESS Verbindet Zugang und Endpunkt.
Idempotenz RESTSRV_IDEMPOTENCY Speichert die Antwort zu jedem Idempotency-Key.
Sitzung RESTSRV_TOKEN Sitzungen der JWT-Anmeldung. Grundlage für das sofortige Abmelden.
Protokoll RESTSRV_PROTO Auffälligkeiten: abgewiesene und fehlerhafte Anfragen, Start, Bindungen, Zertifikate, Skriptfehler.
Statistik RESTSRV_STATS Eine Zeile je verarbeiteter Anfrage mit Zugang, Endpunkt, Status und Laufzeit.

So läuft eine Anfrage

  1. Der Client verbindet sich per HTTPS mit einer Bindung eines Server-Profils.
  2. Der Server prüft Rate-Limit und Auslastung des Profils.
  3. Er ordnet die Anfrage über den API-Key einem Zugang zu und prüft Host, Origin und gegebenenfalls das Client-Zertifikat.
  4. Verlangt der Zugang JWT, prüft er Token und Sitzung.
  5. Er findet den Endpunkt über das Pfad-Template und prüft die Berechtigung des Zugangs.
  6. Bei schreibenden Anfragen prüft er den Idempotency-Key.
  7. Das Skript des Endpunkts läuft. Schreibende Anfragen laufen in einer Datenbanktransaktion.
  8. Der Server sendet die Antwort mit einer Korrelations-ID und schreibt die Statistik.

Die vollständige Reihenfolge mit allen Statuscodes beschreibt HTTP-Schnittstelle.

Sicherheit

Der REST-Server ist für den Betrieb im Internet gebaut:

  • Verschlüsselung ist Pflicht. Server-Profile sprechen ausschließlich TLS 1.2 mit Forward Secrecy. Klartext gibt es nur mit dem Haken kein SSL (Plain-HTTP - nur für Debug!). Zertifikate erneuert der Dienst auf Wunsch selbst. Siehe Server-Profile und Zertifikatserneuerung.
  • Ein API-Key je Zugang. Jeder Zugang sieht nur die Endpunkte, für die er freigeschaltet ist. Zusätzlich beschränken Sie ihn auf einen Host, auf erlaubte Browser-Origins oder per mTLS auf ein Client-Zertifikat. Siehe Zugänge.
  • JWT-Anmeldung mit Sitzungen. Benutzer melden sich einzeln an. Ein Abmelden wirkt sofort. Siehe Anmeldung mit JWT.
  • Rate-Limit und Andrangsgrenze bremsen Missbrauch und Lastspitzen. Gezählt wird je API-Key, ohne Key je IP-Adresse.
  • Keine Doppelbuchungen. Schreibende Anfragen tragen einen Idempotency-Key. Eine Wiederholung wirkt nur einmal. Siehe HTTP-Schnittstelle.
  • Keine internen Details nach außen. Fehlerantworten sind allgemein gehalten. Den Grund findet der Betreiber über die Korrelations-ID im Protokoll. Siehe Betrieb und Fehlersuche.