OBS/Kostenpflichtige Module/RESTServer/Einrichtung - Versionsgeschichte

Rademacker am 31. August 2026 um 05:04 Uhr

2026-08-31T05:04:01Z

← Nächstältere Version		Version vom 31. August 2026, 06:04 Uhr
Zeile 108:		Zeile 108:
	* Skript geändert, aber der Aufruf verhält sich noch wie vorher -> Endpunkt-Cache abwarten (bis zu 60 Sekunden).		* Skript geändert, aber der Aufruf verhält sich noch wie vorher -> Endpunkt-Cache abwarten (bis zu 60 Sekunden).
	* Wiederholter Schreibaufruf liefert 422 ''IDEMPOTENCY_KEY_REUSED'' -> der Client sendet denselben ''Idempotency-Key'' mit geändertem Inhalt. Pro Vorgang genau ein Schlüssel, über alle Wiederholversuche hinweg unverändert.		* Wiederholter Schreibaufruf liefert 422 ''IDEMPOTENCY_KEY_REUSED'' -> der Client sendet denselben ''Idempotency-Key'' mit geändertem Inhalt. Pro Vorgang genau ein Schlüssel, über alle Wiederholversuche hinweg unverändert.
	* Wiederholter Schreibaufruf liefert 409 ''IDEMPOTENCY_UNRESOLVED'' -> ein früherer Versuch wurde ~~unterbrochen~~. Ob gebucht wurde, ist offen: im Protokoll und in den Fachdaten prüfen~~, dann~~ den Eintrag in '''RESTSRV_IDEMPOTENCY''' ~~entfernen~~.		* Wiederholter Schreibaufruf liefert 409 ''IDEMPOTENCY_UNRESOLVED'' -> ein früherer Versuch wurde hart abgebrochen (Dienst beendet). Ob gebucht wurde, ist offen: im Protokoll und in den Fachdaten prüfen. Der Aufräumlauf gibt den Eintrag nach 24 Stunden von selbst frei; wer schneller weitermachen will, entfernt ihn in '''RESTSRV_IDEMPOTENCY'''.
	* Nach einem Update antworten '''alle''' bestehenden Token mit 401 ''AUTH_EXPIRED'' -> erwartetes Verhalten. Token, die vor der Einführung der Sitzungsprüfung ausgestellt wurden, gehören zu keiner Sitzung; die Konsumenten müssen sich einmalig neu anmelden.		* Nach einem Update antworten '''alle''' bestehenden Token mit 401 ''AUTH_EXPIRED'' -> erwartetes Verhalten. Token, die vor der Einführung der Sitzungsprüfung ausgestellt wurden, gehören zu keiner Sitzung; die Konsumenten müssen sich einmalig neu anmelden.
	* Anmeldung liefert 503 statt eines Tokens -> die Sitzungszeile konnte nicht geschrieben werden. Ursache im Protokoll unter ''TokenStore: ...'' nachsehen; typisch ist eine fehlende Tabelle '''RESTSRV_TOKEN''' nach einem Update ohne Datenbank-Abgleich.		* Anmeldung liefert 503 statt eines Tokens -> die Sitzungszeile konnte nicht geschrieben werden. Ursache im Protokoll unter ''TokenStore: ...'' nachsehen; typisch ist eine fehlende Tabelle '''RESTSRV_TOKEN''' nach einem Update ohne Datenbank-Abgleich.
	* Abmelden liefert 503 -> die Sitzung liess sich nicht sperren. Der Client ist '''nicht''' abgemeldet und muss den Aufruf wiederholen; Details im Protokoll.		* Abmelden liefert 503 -> die Sitzung liess sich nicht sperren. Der Client ist '''nicht''' abgemeldet und muss den Aufruf wiederholen; Details im Protokoll.
	* Techniker wird beim Arbeiten unerwartet abgemeldet -> im Protokoll nach ''WIEDERVORLAGE'' suchen. Ein doppelt verwendetes Refresh-Token sperrt die Sitzung. Legt die App Token mehrfach parallel ab, gehört das clientseitig behoben.		* Techniker wird beim Arbeiten unerwartet abgemeldet -> im Protokoll nach ''WIEDERVORLAGE'' suchen. Ein doppelt verwendetes Refresh-Token sperrt die Sitzung. Legt die App Token mehrfach parallel ab, gehört das clientseitig behoben.

Rademacker am 19. August 2026 um 10:15 Uhr

2026-08-19T10:15:30Z

@@ Zeile 81: / Zeile 81: @@
 * In der Zugänge-Liste '''F8''' für die Statistik des Zugangs.
 * In '''Stammdaten -> Z Weitere Stammdaten -> REST-Server -> Protokoll''' die Ereignisse prüfen.
 ==Häufige Stolpersteine==
@@ Zeile 94: / Zeile 109: @@
 * Wiederholter Schreibaufruf liefert 422 ''IDEMPOTENCY_KEY_REUSED'' -> der Client sendet denselben ''Idempotency-Key'' mit geändertem Inhalt. Pro Vorgang genau ein Schlüssel, über alle Wiederholversuche hinweg unverändert.
 * Wiederholter Schreibaufruf liefert 409 ''IDEMPOTENCY_UNRESOLVED'' -> ein früherer Versuch wurde unterbrochen. Ob gebucht wurde, ist offen: im Protokoll und in den Fachdaten prüfen, dann den Eintrag in '''RESTSRV_IDEMPOTENCY''' entfernen.

Rademacker am 17. August 2026 um 06:53 Uhr

2026-08-17T06:53:56Z

← Nächstältere Version		Version vom 17. August 2026, 07:53 Uhr
Zeile 21:		Zeile 21:
	** '''mTLS''' aktivieren: zusätzlich CA-Root-Zertifikat hinterlegen, jeder Client muss ein gültiges Cert vorlegen.		** '''mTLS''' aktivieren: zusätzlich CA-Root-Zertifikat hinterlegen, jeder Client muss ein gültiges Cert vorlegen.
	** '''Kein SSL''' aktivieren: ausschliesslich für lokale Tests, der Server akzeptiert dann nur Plain-HTTP.		** '''Kein SSL''' aktivieren: ausschliesslich für lokale Tests, der Server akzeptiert dann nur Plain-HTTP.

			Optional lassen sich am Profil eigene '''Rate-Limit-Schwellen''' hinterlegen. Ohne
			Angabe gelten die Standardwerte (60-Sekunden-Fenster, 120 erfolgreiche und 10
			fehlgeschlagene Anfragen je Schlüssel, 600 Anfragen je Profil). Für Anwendungen
			ohne eigenen API-Key - typisch mobile Apps - sollten die Werte bewusst gesetzt
			werden, weil dann alle Benutzer hinter einer IP auf denselben Zähler laufen.

	Details siehe [[OBS/Kostenpflichtige Module/RESTServer/Server-Profile\|Server-Profile]].		Details siehe [[OBS/Kostenpflichtige Module/RESTServer/Server-Profile\|Server-Profile]].
Zeile 52:		Zeile 58:
	* '''Pfad-Template''' - der maßgebliche Routing-Pfad, ggf. mit Platzhaltern (z.B. ''/orders'', ''/orders/{uid}'', ''/orders/{uid}/modules/{code}'').		* '''Pfad-Template''' - der maßgebliche Routing-Pfad, ggf. mit Platzhaltern (z.B. ''/orders'', ''/orders/{uid}'', ''/orders/{uid}/modules/{code}'').
	* '''Server''' - die Server-Auswahl bestimmt, über welches Server-Profil der Endpunkt erreichbar ist.		* '''Server''' - die Server-Auswahl bestimmt, über welches Server-Profil der Endpunkt erreichbar ist.
			* '''Datei-Upload''' - nur setzen, wenn der Endpunkt Dateien entgegennehmen soll; dann auch die '''Max. Upload-Grösse''' in MB festlegen (siehe [[OBS/Kostenpflichtige Module/RESTServer/Beispiel6\|Beispiel 6]]).

	{{Hinweis\|Die früheren Felder '''Sub-URL''' und '''Version''' werden nicht mehr ausgewertet. Eine Versionskennung wird ggf. als statisches Segment ins Pfad-Template aufgenommen (z.B. ''/orders/v1''). Details: [[OBS/Kostenpflichtige Module/RESTServer/Endpunkte\|Endpunkte]].}}		{{Hinweis\|Die früheren Felder '''Sub-URL''' und '''Version''' werden nicht mehr ausgewertet. Eine Versionskennung wird ggf. als statisches Segment ins Pfad-Template aufgenommen (z.B. ''/orders/v1''). Details: [[OBS/Kostenpflichtige Module/RESTServer/Endpunkte\|Endpunkte]].}}
Zeile 83:		Zeile 90:
	* Falscher API-Key oder falscher Host beim Zugang -> Aufruf liefert 401 bzw. 403.		* Falscher API-Key oder falscher Host beim Zugang -> Aufruf liefert 401 bzw. 403.
	* mTLS aktiv, aber kein Client-Zertifikat installiert -> Verbindung wird während des TLS-Handshakes abgebrochen.		* mTLS aktiv, aber kein Client-Zertifikat installiert -> Verbindung wird während des TLS-Handshakes abgebrochen.
			* Datei-Upload ohne gesetzten Haken '''Datei-Upload''' am Endpunkt -> Aufruf liefert 415, das Skript läuft nicht an.
			* Skript geändert, aber der Aufruf verhält sich noch wie vorher -> Endpunkt-Cache abwarten (bis zu 60 Sekunden).
			* Wiederholter Schreibaufruf liefert 422 ''IDEMPOTENCY_KEY_REUSED'' -> der Client sendet denselben ''Idempotency-Key'' mit geändertem Inhalt. Pro Vorgang genau ein Schlüssel, über alle Wiederholversuche hinweg unverändert.
			* Wiederholter Schreibaufruf liefert 409 ''IDEMPOTENCY_UNRESOLVED'' -> ein früherer Versuch wurde unterbrochen. Ob gebucht wurde, ist offen: im Protokoll und in den Fachdaten prüfen, dann den Eintrag in '''RESTSRV_IDEMPOTENCY''' entfernen.

Rademacker am 15. Juni 2026 um 07:24 Uhr

2026-06-15T07:24:58Z

← Nächstältere Version		Version vom 15. Juni 2026, 08:24 Uhr
Zeile 49:		Zeile 49:
	Unter '''Endpunkte''' mit '''Einfg''' einen neuen Endpunkt anlegen:		Unter '''Endpunkte''' mit '''Einfg''' einen neuen Endpunkt anlegen:

	* '''Endpunkt''' - ~~der Hauptname~~ (z.B. ''~~kalender~~'', ''~~zeiterfa~~'').		* '''Endpunkt''' - Ressourcen-/Anzeigename (z.B. ''orders'', ''kalender''); dient nur der Übersicht, nicht dem Routing.
	* '''~~Sub~~-~~URL~~''' - ~~optional~~, z.B. ''~~mobile~~''.		* '''Pfad-Template''' - der maßgebliche Routing-Pfad, ggf. mit Platzhaltern (z.B. ''/orders'', ''/orders/{uid}'', ''/orders/{uid}/modules/{code}'').
	* '''~~Version~~''' ~~- z.B. ''v1~~''.
	* '''Server''' - die Server-Auswahl bestimmt, über welches Server-Profil der Endpunkt erreichbar ist.		* '''Server''' - die Server-Auswahl bestimmt, über welches Server-Profil der Endpunkt erreichbar ist.

			{{Hinweis\|Die früheren Felder '''Sub-URL''' und '''Version''' werden nicht mehr ausgewertet. Eine Versionskennung wird ggf. als statisches Segment ins Pfad-Template aufgenommen (z.B. ''/orders/v1''). Details: [[OBS/Kostenpflichtige Module/RESTServer/Endpunkte\|Endpunkte]].}}

	Anschliessend mit '''F7''' das Endpunkt-Skript pflegen (siehe [[OBS/Kostenpflichtige Module/RESTServer/Scripting\|Scripting]]).		Anschliessend mit '''F7''' das Endpunkt-Skript pflegen (siehe [[OBS/Kostenpflichtige Module/RESTServer/Scripting\|Scripting]]).
Zeile 64:		Zeile 65:
	Aufruf mit einem HTTP-Client (curl, Postman, Browser-Plug-in):		Aufruf mit einem HTTP-Client (curl, Postman, Browser-Plug-in):

	curl -H "apikey: [API-KEY]" https://api.meinserver.de/[~~Endpunkt]/[Version~~]		curl -H "apikey: [API-KEY]" https://api.meinserver.de/[Pfad-Template]

	Bei korrektem Setup erscheint die JSON-Antwort des Skripts. Fehlerfälle werden in '''RESTSRV_PROTO''' protokolliert.		Bei korrektem Setup erscheint die JSON-Antwort des Skripts. Fehlerfälle werden in '''RESTSRV_PROTO''' protokolliert.
Zeile 78:		Zeile 79:
	* Bindung angelegt, aber der Server wurde nicht neugestartet -> die Bindung ist noch nicht aktiv.		* Bindung angelegt, aber der Server wurde nicht neugestartet -> die Bindung ist noch nicht aktiv.
	* Endpunkt einem falschen Server zugeordnet -> Aufruf liefert 404 ''Endpunkt nicht vorhanden oder inaktiv''.		* Endpunkt einem falschen Server zugeordnet -> Aufruf liefert 404 ''Endpunkt nicht vorhanden oder inaktiv''.
			* Pfad-Template falsch geschrieben oder Segmentzahl passt nicht -> kein Template matcht, Aufruf liefert 404.
	* Zugang für den Endpunkt nicht freigeschaltet -> Aufruf liefert 403 ''Keine Berechtigung für die Endpunkt-Nutzung''.		* Zugang für den Endpunkt nicht freigeschaltet -> Aufruf liefert 403 ''Keine Berechtigung für die Endpunkt-Nutzung''.
	* Falscher API-Key oder falscher Host beim Zugang -> Aufruf liefert 401 bzw. 403.		* Falscher API-Key oder falscher Host beim Zugang -> Aufruf liefert 401 bzw. 403.
	* mTLS aktiv, aber kein Client-Zertifikat installiert -> Verbindung wird während des TLS-Handshakes abgebrochen.		* mTLS aktiv, aber kein Client-Zertifikat installiert -> Verbindung wird während des TLS-Handshakes abgebrochen.

Rademacker am 19. Mai 2026 um 07:13 Uhr

2026-05-19T07:13:52Z

← Nächstältere Version		Version vom 19. Mai 2026, 08:13 Uhr
Zeile 22:		Zeile 22:
	** '''Kein SSL''' aktivieren: ausschliesslich für lokale Tests, der Server akzeptiert dann nur Plain-HTTP.		** '''Kein SSL''' aktivieren: ausschliesslich für lokale Tests, der Server akzeptiert dann nur Plain-HTTP.

	Details siehe [[OBS/Kostenpflichtige Module/RESTServer/Server-~~Profil~~\|Server-Profile]].		Details siehe [[OBS/Kostenpflichtige Module/RESTServer/Server-Profile\|Server-Profile]].

	==Schritt 2: Bindung anlegen==		==Schritt 2: Bindung anlegen==

Rademacker am 19. Mai 2026 um 07:13 Uhr

2026-05-19T07:13:43Z

← Nächstältere Version		Version vom 19. Mai 2026, 08:13 Uhr
Zeile 22:		Zeile 22:
	** '''Kein SSL''' aktivieren: ausschliesslich für lokale Tests, der Server akzeptiert dann nur Plain-HTTP.		** '''Kein SSL''' aktivieren: ausschliesslich für lokale Tests, der Server akzeptiert dann nur Plain-HTTP.

	Details siehe [[OBS/Kostenpflichtige Module/RESTServer/Server\|Server-Profile]].		Details siehe [[OBS/Kostenpflichtige Module/RESTServer/Server-Profil\|Server-Profile]].

	==Schritt 2: Bindung anlegen==		==Schritt 2: Bindung anlegen==

Rademacker am 19. Mai 2026 um 06:06 Uhr

2026-05-19T06:06:49Z

Rademacker am 19. Mai 2026 um 05:39 Uhr

2026-05-19T05:39:22Z

@@ Zeile 3: / Zeile 3: @@
 =Einrichtung eines REST-Endpunktes=
-Schritte für die Einrichtung eines lauffähigen REST-Endpunktes:
+Die folgende Reihenfolge stellt sicher, dass ein lauffaehiger Endpunkt mit moeglichst wenigen Korrektur-Schleifen entsteht.
-* Bindung anlegen
+==Vorbereitung==
-Jetzt ist der Endpunkt aktiv und kann Anfragen verarbeiten.
+# OBS-Support kontaktieren und das REST-Server-Modul aktivieren lassen.

Rademacker am 26. Juli 2023 um 05:58 Uhr

2023-07-26T05:58:47Z

← Nächstältere Version		Version vom 26. Juli 2023, 06:58 Uhr
Zeile 3:		Zeile 3:
	=Einrichtung eines REST-Endpunktes=		=Einrichtung eines REST-Endpunktes=

	~~Hier ist eine Schritt-für-Schritt-Anleitung~~ für die Einrichtung eines lauffähigen REST-Endpunktes:		Schritte für die Einrichtung eines lauffähigen REST-Endpunktes:

	* Bindung anlegen		* Bindung anlegen
	* REST-Dienst starten/neustarten		* REST-Dienst starten/neustarten
	* Zugang anlegen		* Zugang anlegen
	* Endpunkt anlegen		* Endpunkt mit Script anlegen
	* Zugang authorisieren		* Zugang authorisieren

			Jetzt ist der Endpunkt aktiv und kann Anfragen verarbeiten.

Rademacker: Die Seite wurde neu angelegt: „{{Kostenpflichtige Module}} =Einrichtung eines REST-Endpunktes= Hier ist eine Schritt-für-Schritt-Anleitung für die Einrichtung eines lauffähigen REST-Endpunktes: * Bindung anlegen * REST-Dienst starten/neustarten * Zugang anlegen * Endpunkt anlegen * Zugang authorisieren“

2023-07-26T05:05:46Z

Die Seite wurde neu angelegt: „{{Kostenpflichtige Module}} =Einrichtung eines REST-Endpunktes= Hier ist eine Schritt-für-Schritt-Anleitung für die Einrichtung eines lauffähigen REST-Endpunktes: * Bindung anlegen * REST-Dienst starten/neustarten * Zugang anlegen * Endpunkt anlegen * Zugang authorisieren“

← Nächstältere Version		Version vom 26. Juli 2023, 06:05 Uhr
Zeile 1:		Zeile 1:
	~~Hello! <br>I'm Bengali female :D. <br>I really love Stamp collecting!<br><br>my web~~-~~site suspenders look~~ - ~~[http~~:/~~/www.doctorbridge.com:8080/UserProfile/tabid/61/userId/1117121/Default.aspx www.doctorbridge.com] -~~		{{Kostenpflichtige Module}}

			=Einrichtung eines REST-Endpunktes=

			Hier ist eine Schritt-für-Schritt-Anleitung für die Einrichtung eines lauffähigen REST-Endpunktes:

			* Bindung anlegen
			* REST-Dienst starten/neustarten
			* Zugang anlegen
			* Endpunkt anlegen
			* Zugang authorisieren

← Nächstältere Version		Version vom 19. Mai 2026, 07:06 Uhr
Zeile 3:		Zeile 3:
	=Einrichtung eines REST-Endpunktes=		=Einrichtung eines REST-Endpunktes=

	Die folgende Reihenfolge stellt sicher, dass ein ~~lauffaehiger~~ Endpunkt mit ~~moeglichst~~ wenigen Korrektur-Schleifen entsteht.		Die folgende Reihenfolge stellt sicher, dass ein lauffähiger Endpunkt mit möglichst wenigen Korrektur-Schleifen entsteht.

	==Vorbereitung==		==Vorbereitung==

	# OBS-Support kontaktieren und das REST-Server-Modul aktivieren lassen.		# OBS-Support kontaktieren und das REST-Server-Modul aktivieren lassen.
	# ~~Pruefen~~, ob auf dem Zielrechner (OBS-Server oder dedizierter REST-Server) Port und IP-Adresse frei sind.		# Prüfen, ob auf dem Zielrechner (OBS-Server oder dedizierter REST-Server) Port und IP-Adresse frei sind.
	# Bei TLS-Profilen: TLS-Zertifikat (PEM, ggf. mit Chain), privaten ~~Schluessel~~ (PEM) und - falls mTLS - das CA-Root-Zertifikat bereithalten.		# Bei TLS-Profilen: TLS-Zertifikat (PEM, ggf. mit Chain), privaten Schlüssel (PEM) und - falls mTLS - das CA-Root-Zertifikat bereithalten.

	==Schritt 1: Server-Profil anlegen==		==Schritt 1: Server-Profil anlegen==

	In '''Stammdaten -> Z Weitere Stammdaten -> REST-Server''' den Punkt '''Server''' ~~oeffnen~~ und mit '''Einfg''' ein neues Profil anlegen. Pflichtfelder:		In '''Stammdaten -> Z Weitere Stammdaten -> REST-Server''' den Punkt '''Server''' öffnen und mit '''Einfg''' ein neues Profil anlegen. Pflichtfelder:

	* '''Nr''' - eindeutige Nummer (1-99), wird beim Anlegen automatisch vorgeschlagen.		* '''Nr''' - eindeutige Nummer (1-99), wird beim Anlegen automatisch vorgeschlagen.
Zeile 19:		Zeile 19:
	* Auswahl des Modus:		* Auswahl des Modus:
	** '''Standard-TLS''' (Default): Zertifikat + Key + Root-Zertifikat hinterlegen.		** '''Standard-TLS''' (Default): Zertifikat + Key + Root-Zertifikat hinterlegen.
	** '''mTLS''' aktivieren: ~~zusaetzlich~~ CA-Root-Zertifikat hinterlegen, jeder Client muss ein ~~gueltiges~~ Cert vorlegen.		** '''mTLS''' aktivieren: zusätzlich CA-Root-Zertifikat hinterlegen, jeder Client muss ein gültiges Cert vorlegen.
	** '''Kein SSL''' aktivieren: ausschliesslich ~~fuer~~ lokale Tests, der Server akzeptiert dann nur Plain-HTTP.		** '''Kein SSL''' aktivieren: ausschliesslich für lokale Tests, der Server akzeptiert dann nur Plain-HTTP.

	Details siehe [[OBS/Kostenpflichtige Module/RESTServer/Server\|Server-Profile]].		Details siehe [[OBS/Kostenpflichtige Module/RESTServer/Server\|Server-Profile]].
Zeile 26:		Zeile 26:
	==Schritt 2: Bindung anlegen==		==Schritt 2: Bindung anlegen==

	Im Server-Profil mit '''F6''' die Bindungs-Liste ~~oeffnen~~ und mit '''Einfg''' eine neue Bindung anlegen:		Im Server-Profil mit '''F6''' die Bindungs-Liste öffnen und mit '''Einfg''' eine neue Bindung anlegen:

	* '''Host''' - IP-Adresse, auf der gelauscht werden soll (z.B. ''0.0.0.0'' ~~fuer~~ alle Adressen, ''127.0.0.1'' ~~fuer~~ lokal).		* '''Host''' - IP-Adresse, auf der gelauscht werden soll (z.B. ''0.0.0.0'' für alle Adressen, ''127.0.0.1'' für lokal).
	* '''Port''' - Port-Nummer (typisch 443 ~~fuer~~ HTTPS, 8099 ~~fuer~~ Debug, ggf. abweichend).		* '''Port''' - Port-Nummer (typisch 443 für HTTPS, 8099 für Debug, ggf. abweichend).
	* '''Standard''' setzen, wenn diese Bindung die Standard-Bindung des Servers ist (pro Server-Profil nur eine).		* '''Standard''' setzen, wenn diese Bindung die Standard-Bindung des Servers ist (pro Server-Profil nur eine).

	==Schritt 3: REST-Dienst starten / neustarten==		==Schritt 3: REST-Dienst starten / neustarten==

	Damit ~~Aenderungen~~ an Server-Profilen oder Bindungen wirksam werden, muss der OBS REST-Server-Dienst (oder die Konsole) gestartet bzw. neugestartet werden. Das Profil wird beim Start aus der Datenbank gelesen.		Damit Änderungen an Server-Profilen oder Bindungen wirksam werden, muss der OBS REST-Server-Dienst (oder die Konsole) gestartet bzw. neugestartet werden. Das Profil wird beim Start aus der Datenbank gelesen.

	==Schritt 4: Zugang anlegen==		==Schritt 4: Zugang anlegen==

	Unter '''~~Zugaenge~~''' mit '''Einfg''' einen neuen Zugang anlegen:		Unter '''Zugänge''' mit '''Einfg''' einen neuen Zugang anlegen:

	* '''Name''' - erscheint im Protokoll und in der Statistik.		* '''Name''' - erscheint im Protokoll und in der Statistik.
	* '''API-Key''' - eindeutig, mit dem ~~Schluesselsymbol~~ kann ein ~~zufaelliger~~ Key generiert werden.		* '''API-Key''' - eindeutig, mit dem Schlüsselsymbol kann ein zufälliger Key generiert werden.
	* '''Host''' - optional die IP oder der Hostname des Konsumenten (sollte, wenn ~~moeglich~~, immer gesetzt werden).		* '''Host''' - optional die IP oder der Hostname des Konsumenten (sollte, wenn möglich, immer gesetzt werden).
	* Optional: '''CORS-Origins''' und '''JWT-Konfiguration''', siehe [[OBS/Kostenpflichtige Module/RESTServer/Zugaenge\|~~Zugaenge~~]].		* Optional: '''CORS-Origins''' und '''JWT-Konfiguration''', siehe [[OBS/Kostenpflichtige Module/RESTServer/Zugaenge\|Zugänge]].

	==Schritt 5: Endpunkt anlegen==		==Schritt 5: Endpunkt anlegen==
Zeile 52:		Zeile 52:
	* '''Sub-URL''' - optional, z.B. ''mobile''.		* '''Sub-URL''' - optional, z.B. ''mobile''.
	* '''Version''' - z.B. ''v1''.		* '''Version''' - z.B. ''v1''.
	* '''Server''' - die Server-Auswahl bestimmt, ~~ueber~~ welches Server-Profil der Endpunkt erreichbar ist.		* '''Server''' - die Server-Auswahl bestimmt, über welches Server-Profil der Endpunkt erreichbar ist.

	Anschliessend mit '''F7''' das Endpunkt-Skript pflegen (siehe [[OBS/Kostenpflichtige Module/RESTServer/Scripting\|Scripting]]).		Anschliessend mit '''F7''' das Endpunkt-Skript pflegen (siehe [[OBS/Kostenpflichtige Module/RESTServer/Scripting\|Scripting]]).

	==Schritt 6: Zugang ~~fuer~~ den Endpunkt freischalten==		==Schritt 6: Zugang für den Endpunkt freischalten==

	Aus der Endpunkt-Liste den neuen Endpunkt markieren und '''F6''' ~~druecken~~. Es ~~oeffnet~~ sich die Berechtigungs-Liste. Mit '''Einfg''' kann ein oder mehrere ~~Zugaenge ausgewaehlt~~ und mit '''F2''' ~~uebernommen~~ werden. Erst nach dieser Freischaltung darf ein Zugang den Endpunkt aufrufen.		Aus der Endpunkt-Liste den neuen Endpunkt markieren und '''F6''' drücken. Es öffnet sich die Berechtigungs-Liste. Mit '''Einfg''' kann ein oder mehrere Zugänge ausgewählt und mit '''F2''' übernommen werden. Erst nach dieser Freischaltung darf ein Zugang den Endpunkt aufrufen.

	==Schritt 7: ~~Funktionspruefung~~==		==Schritt 7: Funktionsprüfung==

	Aufruf mit einem HTTP-Client (curl, Postman, Browser-Plug-in):		Aufruf mit einem HTTP-Client (curl, Postman, Browser-Plug-in):
Zeile 66:		Zeile 66:
	curl -H "apikey: [API-KEY]" https://api.meinserver.de/[Endpunkt]/[Version]		curl -H "apikey: [API-KEY]" https://api.meinserver.de/[Endpunkt]/[Version]

	Bei korrektem Setup erscheint die JSON-Antwort des Skripts. ~~Fehlerfaelle~~ werden in '''RESTSRV_PROTO''' protokolliert.		Bei korrektem Setup erscheint die JSON-Antwort des Skripts. Fehlerfälle werden in '''RESTSRV_PROTO''' protokolliert.

	==Schritt 8: Statistik und Protokoll ~~pruefen~~==		==Schritt 8: Statistik und Protokoll prüfen==

	* In der Endpunkt-Liste '''F8''' ~~fuer~~ die Statistik des Endpunkts.		* In der Endpunkt-Liste '''F8''' für die Statistik des Endpunkts.
	* In der ~~Zugaenge~~-Liste '''F8''' ~~fuer~~ die Statistik des Zugangs.		* In der Zugänge-Liste '''F8''' für die Statistik des Zugangs.
	* In '''Stammdaten -> Z Weitere Stammdaten -> REST-Server -> Protokoll''' die Ereignisse ~~pruefen~~.		* In '''Stammdaten -> Z Weitere Stammdaten -> REST-Server -> Protokoll''' die Ereignisse prüfen.

	==~~Haeufige~~ Stolpersteine==		==Häufige Stolpersteine==

	* Bindung angelegt, aber der Server wurde nicht neugestartet -> die Bindung ist noch nicht aktiv.		* Bindung angelegt, aber der Server wurde nicht neugestartet -> die Bindung ist noch nicht aktiv.
	* Endpunkt einem falschen Server zugeordnet -> Aufruf liefert 404 ''Endpunkt nicht vorhanden oder inaktiv''.		* Endpunkt einem falschen Server zugeordnet -> Aufruf liefert 404 ''Endpunkt nicht vorhanden oder inaktiv''.
	* Zugang ~~fuer~~ den Endpunkt nicht freigeschaltet -> Aufruf liefert 403 ''Keine Berechtigung ~~fuer~~ die Endpunkt-Nutzung''.		* Zugang für den Endpunkt nicht freigeschaltet -> Aufruf liefert 403 ''Keine Berechtigung für die Endpunkt-Nutzung''.
	* Falscher API-Key oder falscher Host beim Zugang -> Aufruf liefert 401 bzw. 403.		* Falscher API-Key oder falscher Host beim Zugang -> Aufruf liefert 401 bzw. 403.
	* mTLS aktiv, aber kein Client-Zertifikat installiert -> Verbindung wird ~~waehrend~~ des TLS-Handshakes abgebrochen.		* mTLS aktiv, aber kein Client-Zertifikat installiert -> Verbindung wird während des TLS-Handshakes abgebrochen.