Zum Inhalt springen

OBS/Kostenpflichtige Module/REST-Server/Einrichtung: Unterschied zwischen den Versionen

Aus OBS Wiki
MINERVA-Rademacker (Diskussion | Beiträge)
Links auf die neuen Titel (REST-Server, Zugänge, Beispiele) umgestellt, zitierte Meldungen mit Umlauten wie im Programm [Volltext ersetzt]
MINERVA-Rademacker (Diskussion | Beiträge)
Schritte auf die neue Pflege umgestellt (Strg+2/3/4, Freischaltung per F6 in den Endpunkten, Profil am Zugang) [Volltext ersetzt]
 
Zeile 26: Zeile 26:
=== Server-Profil anlegen ===
=== Server-Profil anlegen ===
{{Schritte|1=
{{Schritte|1=
# Wählen Sie '''Stammdaten → Z Weitere Stammdaten → REST-Server''' und öffnen Sie den Punkt '''Server'''.
# Wählen Sie '''Stammdaten → Z Weitere Stammdaten → REST-Server'''. Die [[OBS/Kostenpflichtige Module/REST-Server/Pflege|Pflege]] öffnet sich, links oben steht die Liste der Server-Profile.
# Drücken Sie {{Einfg}}. OBS schlägt eine freie '''Nr''' zwischen 1 und 99 vor. Tragen Sie einen '''Name''' ein, z.B. ''Public-API''.
# Drücken Sie {{Einfg}}. OBS schlägt eine freie '''Nr''' zwischen 1 und 99 vor. Tragen Sie einen '''Name''' ein, z.B. ''Public-API''.
# Hinterlegen Sie auf der Registerkarte '''3 Zertifikate''' das '''Zertifikat (cert)''' und den '''Schlüssel (key)'''. Alternativ richten Sie auf der Registerkarte '''4 Zertifikaterneuerung''' die '''Automatische Erneuerung''' oder '''Eigenes Zertifikat (Pin)''' ein.
# Hinterlegen Sie auf der Registerkarte '''3 Zertifikate''' das '''Zertifikat (cert)''' und den '''Schlüssel (key)'''. Alternativ richten Sie auf der Registerkarte '''4 Zertifikaterneuerung''' die '''Automatische Erneuerung''' oder '''Eigenes Zertifikat (Pin)''' ein.
Zeile 35: Zeile 35:
}}
}}


{{Hinweis|Das Rate-Limit zählt je API-Key, ohne Key je IP-Adresse. Alle Geräte, die denselben API-Key verwenden, teilen sich einen Zähler. Planen Sie die Grenzen nach der Zahl der Geräte je Zugang. Details: [[OBS/Kostenpflichtige Module/REST-Server/Server-Profile|Server-Profile]].}}
{{Hinweis|Das Rate-Limit zählt je API-Key, ohne Key je IP-Adresse. Alle Geräte, die denselben API-Key verwenden, teilen sich einen Zähler. Planen Sie die Grenzen nach der Zahl der Geräte je Zugang. Details: [[OBS/Kostenpflichtige Module/REST-Server/Pflege#Registerkarte: 2 Rate-Limits|Pflege]].}}


=== Bindung anlegen ===
=== Bindung anlegen ===
{{Schritte|1=
{{Schritte|1=
# Wählen Sie in der Liste das Server-Profil und drücken Sie {{F6}}. Die Liste der Bindungen öffnet sich.
# Markieren Sie in der Liste der Profile das Server-Profil und wechseln Sie mit {{Key|Strg}}+{{Key|2}} in die Liste der Bindungen.
# Drücken Sie {{Einfg}}.
# Drücken Sie {{Einfg}}. Das Profil ist unter '''Server''' vorbelegt.
# Tragen Sie unter '''Host''' die IP-Adresse ein, auf der der Dienst lauschen soll, z.B. ''0.0.0.0'' für alle Adressen.
# Tragen Sie unter '''Host''' die IP-Adresse ein, auf der der Dienst lauschen soll, z.B. ''0.0.0.0'' für alle Adressen.
# Tragen Sie unter '''Port''' den Port ein, z.B. ''443''.
# Tragen Sie unter '''Port''' den Port ein, z.B. ''443''.
# Setzen Sie '''Standard''' an der Bindung, deren Port im Zugangscode stehen soll.
# Setzen Sie '''Standard''' an der Bindung, deren Port im Zugangscode stehen soll. Gibt es schon eine Standard-Bindung, fragt OBS, ob der Standard wechseln soll.
# Setzen Sie '''Aktiv''' und speichern Sie mit {{F2}}.
# Setzen Sie '''Aktiv''' und speichern Sie mit {{F2}}.
}}
}}
Zeile 55: Zeile 55:
=== Zugang anlegen ===
=== Zugang anlegen ===
{{Schritte|1=
{{Schritte|1=
# Öffnen Sie unter '''REST-Server''' den Punkt '''Zugänge''' und drücken Sie {{Einfg}}.
# Wechseln Sie mit {{Key|Strg}}+{{Key|3}} in die Liste der Zugänge und drücken Sie {{Einfg}}. Das markierte Profil ist unter '''Server''' vorbelegt. Der API-Key gilt nur auf diesem Profil.
# Tragen Sie einen '''Name''' ein. Er erscheint im Protokoll.
# Tragen Sie einen '''Name''' ein. Er erscheint im Protokoll.
# Klicken Sie neben '''API-Key''' auf die Schaltfläche '''...'''. OBS erzeugt einen zufälligen Key.
# Klicken Sie neben '''API-Key''' auf die Schaltfläche '''...'''. OBS erzeugt einen zufälligen Key.
Zeile 63: Zeile 63:
}}
}}


Bedeutung der Felder: [[OBS/Kostenpflichtige Module/REST-Server/Zugänge|Zugänge]].
Bedeutung der Felder: [[OBS/Kostenpflichtige Module/REST-Server/Pflege#Zugang|Pflege]].


=== JWT-Anmeldung einrichten ===
=== JWT-Anmeldung einrichten ===
Zeile 79: Zeile 79:
=== Endpunkt anlegen ===
=== Endpunkt anlegen ===
{{Schritte|1=
{{Schritte|1=
# Öffnen Sie unter '''REST-Server''' den Punkt '''Endpunkte''' und drücken Sie {{Einfg}}.
# Wechseln Sie mit {{Key|Strg}}+{{Key|4}} in die Liste der Endpunkte und drücken Sie {{Einfg}}. Das markierte Profil ist unter '''Server''' vorbelegt.
# Tragen Sie das '''Pfad-Template''' ein, z.B. ''/service/auftraege'' oder ''/service/auftraege/{nr}''. Das erste Segment ist die App-Kennung im Zugangscode.
# Tragen Sie das '''Pfad-Template''' ein, z.B. ''/service/auftraege'' oder ''/service/auftraege/{nr}''. Das erste Segment ist die App-Kennung im Zugangscode.
# Wählen Sie unter '''Server''' das Server-Profil, über das der Endpunkt erreichbar ist.
# Soll der Endpunkt Dateien annehmen, setzen Sie '''Datei-Upload''' und tragen die '''maximale Dateigröße (MB)''' ein.
# Soll der Endpunkt Dateien annehmen, setzen Sie '''Datei-Upload''' und tragen die '''maximale Dateigröße (MB)''' ein.
# Setzen Sie '''Aktiv''' und speichern Sie mit {{F2}}.
# Setzen Sie '''Aktiv''' und speichern Sie mit {{F2}}.
Zeile 87: Zeile 86:
}}
}}


Pfad-Templates und weitere Felder: [[OBS/Kostenpflichtige Module/REST-Server/Endpunkte|Endpunkte]]. Aufbau der Skripte: [[OBS/Kostenpflichtige Module/REST-Server/Scripting|Scripting]].
Pfad-Templates und weitere Felder: [[OBS/Kostenpflichtige Module/REST-Server/Pflege#Endpunkt|Pflege]]. Aufbau der Skripte: [[OBS/Kostenpflichtige Module/REST-Server/Scripting|Scripting]].


=== Zugang für den Endpunkt freischalten ===
=== Zugang für den Endpunkt freischalten ===
{{Schritte|1=
{{Schritte|1=
# Wählen Sie in der Liste der Endpunkte den Endpunkt und drücken Sie {{F6}}. Die Liste '''Endpunkt Zugang''' öffnet sich.
# Markieren Sie in der Liste der Zugänge den Zugang.
# Drücken Sie {{Einfg}}. Die Liste der Zugänge öffnet sich zur Auswahl.
# Wechseln Sie mit {{Key|Strg}}+{{Key|4}} in die Liste der Endpunkte. Die Spalte '''Zugriff''' zeigt mit ''X'', welche Endpunkte der Zugang schon nutzen darf.
# Markieren Sie mit {{F5}} einen oder mehrere Zugänge.
# Drücken Sie auf dem Endpunkt {{F6}}. Für mehrere Endpunkte markieren Sie diese vorher mit {{F5}}.
# Drücken Sie {{F2}}. OBS übernimmt die markierten Zugänge. Ohne Markierung übernimmt {{F2}} den Zugang, auf dem der Cursor steht.
}}
}}


Erst nach dieser Freischaltung darf ein Zugang den Endpunkt aufrufen.
Erst nach dieser Freischaltung darf ein Zugang den Endpunkt aufrufen. Details: [[OBS/Kostenpflichtige Module/REST-Server/Pflege#Zugriffskontrolle|Zugriffskontrolle]].


=== Zugangscode für eine App ausgeben ===
=== Zugangscode für eine App ausgeben ===
Zeile 113: Zeile 111:
# Verlangt der Zugang JWT, melden Sie sich vorher am JWT-Endpunkt an und senden das Access-Token mit.
# Verlangt der Zugang JWT, melden Sie sich vorher am JWT-Endpunkt an und senden das Access-Token mit.
# Schreibende Aufrufe (<code>POST</code>, <code>PUT</code>, <code>PATCH</code>, <code>DELETE</code>) brauchen zusätzlich den Header <code>Idempotency-Key</code>.
# Schreibende Aufrufe (<code>POST</code>, <code>PUT</code>, <code>PATCH</code>, <code>DELETE</code>) brauchen zusätzlich den Header <code>Idempotency-Key</code>.
# Drücken Sie in der Liste der Endpunkte oder der Zugänge {{F8}}, um die Statistik zu sehen.
# Drücken Sie in der Liste der Endpunkte, der Zugänge oder der Profile {{F8}}, um die Statistik zu sehen.
}}
}}


Zeile 141: Zeile 139:
| Verbindung bricht beim TLS-Aufbau ab || '''mTLS-Modus aktiv''' ist gesetzt, der Client legt kein gültiges Client-Zertifikat vor.
| Verbindung bricht beim TLS-Aufbau ab || '''mTLS-Modus aktiv''' ist gesetzt, der Client legt kein gültiges Client-Zertifikat vor.
|-
|-
| 401 <code>API_KEY_INVALID</code> || Der API-Key ist unbekannt. Ohne Header <code>apikey</code>: Es gibt keinen Zugang mit dem API-Key <code>*</code>.
| 401 <code>API_KEY_INVALID</code> || Der API-Key ist unbekannt oder gehört zu einem Zugang eines anderen Server-Profils. Ohne Header <code>apikey</code>: Es gibt keinen Zugang mit dem API-Key <code>*</code>.
|-
|-
| 401 <code>AUTH_REQUIRED</code> || Am Zugang ist '''JWT-Authentifizierung''' gesetzt, der Client sendet kein Access-Token.
| 401 <code>AUTH_REQUIRED</code> || Am Zugang ist '''JWT-Authentifizierung''' gesetzt, der Client sendet kein Access-Token.
Zeile 163: Zeile 161:
* [[OBS/Kostenpflichtige Module/REST-Server|REST-Server]]
* [[OBS/Kostenpflichtige Module/REST-Server|REST-Server]]
* [[OBS/Kostenpflichtige Module/REST-Server/Öffentliche Freigabe|Öffentliche Freigabe]]
* [[OBS/Kostenpflichtige Module/REST-Server/Öffentliche Freigabe|Öffentliche Freigabe]]
* [[OBS/Kostenpflichtige Module/REST-Server/Server-Profile|Server-Profile]]
* [[OBS/Kostenpflichtige Module/REST-Server/Pflege|Pflege]]
* [[OBS/Kostenpflichtige Module/REST-Server/Zugänge|Zugänge]]
* [[OBS/Kostenpflichtige Module/REST-Server/Endpunkte|Endpunkte]]
* [[OBS/Kostenpflichtige Module/REST-Server/Betrieb und Fehlersuche|Betrieb und Fehlersuche]]
* [[OBS/Kostenpflichtige Module/REST-Server/Betrieb und Fehlersuche|Betrieb und Fehlersuche]]

Aktuelle Version vom 17. November 2026, 11:53 Uhr

Einrichtung

Diese Anleitung führt Sie vom ersten Server-Profil bis zum ersten erfolgreichen Aufruf eines Endpunkts. In dieser Reihenfolge entsteht ein lauffähiger Endpunkt mit möglichst wenigen Korrekturschleifen.

Auf einen Blick
  • Server-Profil und Bindung legen fest, wie und wo der REST-Server erreichbar ist.
  • Zugang ist der Client mit seinem API-Key, auf Wunsch mit JWT-Anmeldung.
  • Endpunkt ist eine Adresse mit Skript. Erst die Freischaltung verbindet Zugang und Endpunkt.
  • Apps erhalten Adresse und API-Key über den Zugangscode.

Voraussetzungen

  • Das Modul REST-Server ist über den OBS-Support freigeschaltet.
  • Der Datenbankabgleich ist durchgeführt. Die Tabellen RESTSRV_TOKEN und RESTSRV_IDEMPOTENCY sind vorhanden. Ohne RESTSRV_TOKEN stellt der Server kein JWT aus. Ohne RESTSRV_IDEMPOTENCY laufen schreibende Anfragen ohne Schutz vor Doppelbuchungen.
  • Auf dem Rechner des REST-Dienstes (OBS-Server oder eigener Server) sind IP-Adresse und Port frei.
  • Für TLS liegt eines davon bereit:
  • Wie der Server von außen erreichbar wird, ist entschieden, siehe Öffentliche Freigabe.

Vorgehen

Server-Profil anlegen

  1. Wählen Sie Stammdaten → Z Weitere Stammdaten → REST-Server. Die Pflege öffnet sich, links oben steht die Liste der Server-Profile.
  2. Drücken Sie Einfg. OBS schlägt eine freie Nr zwischen 1 und 99 vor. Tragen Sie einen Name ein, z.B. Public-API.
  3. Hinterlegen Sie auf der Registerkarte 3 Zertifikate das Zertifikat (cert) und den Schlüssel (key). Alternativ richten Sie auf der Registerkarte 4 Zertifikaterneuerung die Automatische Erneuerung oder Eigenes Zertifikat (Pin) ein.
  4. Für mTLS setzen Sie mTLS-Modus aktiv und hinterlegen das Root-Zertifikat (ca), gegen das die Client-Zertifikate geprüft werden.
  5. Setzen Sie kein SSL (Plain-HTTP - nur für Debug!) nur für lokale Tests.
  6. Auf der Registerkarte 2 Rate-Limits passen Sie bei Bedarf die Grenzen an. 0 bedeutet Standard: Fenster von 60 Sekunden, 120 Erfolgsanfragen und 10 Fehlanfragen je API-Key, 600 Anfragen je Profil.
  7. Setzen Sie Aktiv und speichern Sie mit F2.
HINWEIS: Das Rate-Limit zählt je API-Key, ohne Key je IP-Adresse. Alle Geräte, die denselben API-Key verwenden, teilen sich einen Zähler. Planen Sie die Grenzen nach der Zahl der Geräte je Zugang. Details: Pflege.

Bindung anlegen

  1. Markieren Sie in der Liste der Profile das Server-Profil und wechseln Sie mit Strg+2 in die Liste der Bindungen.
  2. Drücken Sie Einfg. Das Profil ist unter Server vorbelegt.
  3. Tragen Sie unter Host die IP-Adresse ein, auf der der Dienst lauschen soll, z.B. 0.0.0.0 für alle Adressen.
  4. Tragen Sie unter Port den Port ein, z.B. 443.
  5. Setzen Sie Standard an der Bindung, deren Port im Zugangscode stehen soll. Gibt es schon eine Standard-Bindung, fragt OBS, ob der Standard wechseln soll.
  6. Setzen Sie Aktiv und speichern Sie mit F2.

REST-Dienst starten

  1. Starten Sie den REST-Dienst neu. Server-Profile und Bindungen liest der Dienst nur beim Start.
  2. Prüfen Sie im Protokoll, dass das Profil gestartet und die Bindung angelegt ist. Die Meldungen dazu nennt Betrieb und Fehlersuche.

Zugang anlegen

  1. Wechseln Sie mit Strg+3 in die Liste der Zugänge und drücken Sie Einfg. Das markierte Profil ist unter Server vorbelegt. Der API-Key gilt nur auf diesem Profil.
  2. Tragen Sie einen Name ein. Er erscheint im Protokoll.
  3. Klicken Sie neben API-Key auf die Schaltfläche .... OBS erzeugt einen zufälligen Key.
  4. Tragen Sie unter Host die Adresse des Clients ein, wenn sie feststeht.
  5. Für Aufrufe aus dem Browser tragen Sie die erlaubte CORS-Origin ein, für mTLS das erwartete mTLS-Subject.
  6. Setzen Sie Aktiv und speichern Sie mit F2.

Bedeutung der Felder: Pflege.

JWT-Anmeldung einrichten

Nur nötig, wenn sich die Benutzer einer App oder eines Portals einzeln anmelden sollen.

  1. Setzen Sie in der Eingabemaske des Zugangs den Haken JWT-Authentifizierung.
  2. Tragen Sie unter Endpunkt den Pfad für Anmelden, Erneuern und Abmelden ein, z.B. /service/auth.
  3. Klicken Sie neben Secret-Key auf ..., um einen Schlüssel zu erzeugen.
  4. Tragen Sie unter Lebenszeit (Min) die Laufzeit des Access-Tokens ein. Speichern Sie mit F2.
  5. Drücken Sie in der Liste der Zugänge F7 und schreiben Sie das Anmeldeskript mit den Methoden Authenticate und Refresh.

Aufbau des Anmeldeskripts und Ablauf beim Client: Anmeldung mit JWT.

Endpunkt anlegen

  1. Wechseln Sie mit Strg+4 in die Liste der Endpunkte und drücken Sie Einfg. Das markierte Profil ist unter Server vorbelegt.
  2. Tragen Sie das Pfad-Template ein, z.B. /service/auftraege oder /service/auftraege/{nr}. Das erste Segment ist die App-Kennung im Zugangscode.
  3. Soll der Endpunkt Dateien annehmen, setzen Sie Datei-Upload und tragen die maximale Dateigröße (MB) ein.
  4. Setzen Sie Aktiv und speichern Sie mit F2.
  5. Drücken Sie in der Liste der Endpunkte F7 und schreiben Sie das Skript. Je HTTP-Verb gibt es eine Methode: Get, Post, Put, Patch, Delete.

Pfad-Templates und weitere Felder: Pflege. Aufbau der Skripte: Scripting.

Zugang für den Endpunkt freischalten

  1. Markieren Sie in der Liste der Zugänge den Zugang.
  2. Wechseln Sie mit Strg+4 in die Liste der Endpunkte. Die Spalte Zugriff zeigt mit X, welche Endpunkte der Zugang schon nutzen darf.
  3. Drücken Sie auf dem Endpunkt F6. Für mehrere Endpunkte markieren Sie diese vorher mit F5.

Erst nach dieser Freischaltung darf ein Zugang den Endpunkt aufrufen. Details: Zugriffskontrolle.

Zugangscode für eine App ausgeben

  1. Wählen Sie in der Liste der Zugänge den Zugang und drücken Sie F6. Der Dialog Zugangscode für OBS-Smart-App öffnet sich mit vorbelegten Feldern.
  2. Prüfen Sie Host (FQDN) und Port. Hier gehört die Adresse hinein, unter der das Gerät den Server erreicht.
  3. Drücken Sie F2, um den QR-Code anzuzeigen, oder F4, um den Code in die Zwischenablage zu kopieren.

Format, Prüfregeln und Weitergabe: Zugangscode und Zertifikats-Pin.

Funktion prüfen

  1. Rufen Sie den Endpunkt mit einem HTTP-Client auf, z.B. mit curl. Ein Beispiel steht unter diesen Schritten.
  2. Verlangt der Zugang JWT, melden Sie sich vorher am JWT-Endpunkt an und senden das Access-Token mit.
  3. Schreibende Aufrufe (POST, PUT, PATCH, DELETE) brauchen zusätzlich den Header Idempotency-Key.
  4. Drücken Sie in der Liste der Endpunkte, der Zugänge oder der Profile F8, um die Statistik zu sehen.
curl -i -H "apikey: abcdef-ghij-klmn-opqr-stuvwx" https://obs.example.com:8443/service/auftraege

Alle Header und Statuscodes beschreibt HTTP-Schnittstelle.

Ergebnis

Der Aufruf liefert die Antwort des Skripts mit dem Status, den das Skript setzt, und dem Header X-Trace-Id. In der Statistik des Endpunkts und des Zugangs (F8) steht eine Zeile zu dem Aufruf.

Wenn es nicht klappt

Der Client erhält bewusst nur eine allgemeine Meldung. Den genauen Grund finden Sie über die X-Trace-Id im Protokoll.

Meldung Ursache
Neue Bindung antwortet nicht Der REST-Dienst wurde nach dem Anlegen nicht neu gestartet.
Protokoll: „Fehler: Server [<Profil>]: SSL/TLS-Konfiguration fehlt (rsv_cert/rsv_key) - Server kann nicht starten“ Zertifikat (cert) oder Schlüssel (key) fehlt. Nur dieses Profil startet nicht.
Verbindung bricht ab oder 400 „Ungültige Anfragezeile.“ Der Client verwendet https://, das Profil läuft mit kein SSL (Plain-HTTP - nur für Debug!).
400 „Dieser Port erwartet eine TLS-Verbindung. Die Anfrage wurde im Klartext gesendet - bitte https verwenden.“ Der Client verwendet http:// auf einem Profil mit TLS.
Verbindung bricht beim TLS-Aufbau ab mTLS-Modus aktiv ist gesetzt, der Client legt kein gültiges Client-Zertifikat vor.
401 API_KEY_INVALID Der API-Key ist unbekannt oder gehört zu einem Zugang eines anderen Server-Profils. Ohne Header apikey: Es gibt keinen Zugang mit dem API-Key *.
401 AUTH_REQUIRED Am Zugang ist JWT-Authentifizierung gesetzt, der Client sendet kein Access-Token.
403 FORBIDDEN_ROLE „Zugriff verweigert“ Zugang nicht Aktiv, Anfrage nicht vom eingetragenen Host, CORS-Origin nicht erlaubt oder der Zugang ist nicht für den Endpunkt freigeschaltet. Im letzten Fall steht im Protokoll „Keine Berechtigung für die Endpunkt-Nutzung“.
404 NOT_FOUND Kein Pfad-Template passt, die Zahl der Segmente stimmt nicht, der Endpunkt ist nicht Aktiv oder einem anderen Server zugeordnet. Im Protokoll steht „Endpunkt nicht vorhanden oder inaktiv“.
400 IDEMPOTENCY_KEY_MISSING Ein schreibender Aufruf ohne Header Idempotency-Key.
415 UNSUPPORTED_MEDIA_TYPE bei einem Upload Datei-Upload ist am Endpunkt nicht gesetzt.
503 bei der Anmeldung am JWT-Endpunkt Die Tabelle RESTSRV_TOKEN fehlt oder ist nicht beschreibbar. Datenbankabgleich durchführen.
Änderung an Endpunkt oder Skript wirkt nicht Der Server hält Endpunkte bis zu 60 Sekunden im Speicher. Kurz warten.

Weitere Fehlerbilder, Proxy-Betrieb und Wartung der Tabellen: Betrieb und Fehlersuche.

Siehe auch