GSD-RestApi
Die Schnittstelle zwischen der neuen DOCUframe-App und der DOCUframe Datenbank ist der GSD-RestApi-WebService.
Sollte die RestApi bereits installiert sein empfehlen wir für die DOCUframe-App diese nicht weiterzuverwenden sondern einen eigenen Service für die DOCUframe-App zu installieren. In der Konfiguration müssten bestimmte Einstellungen getroffen werden die ggf. für andere Applikationen nicht verwendet werden können.
Sie kann vom GSD-Instservice heruntergeladen und in einem ausgewählten Verzeichnis entpackt werden. Soll die Rest-Api später öffentlich erreicht werden empfiehlt es sich die Installation auf einem dafür vorgesehenen Server durchzuführen.
Beim ersten manuellen Start der net-api.exe werden durch einen Konfigurationsassistenten die wichtigsten Einstellungen abgefragt und eine Konfigurationsdatei api-config.yml erzeugt.
Beispiel-Konfigurationsassistent:
In der Konfigurationsdatei api-config.yml sind folgende Einstellungen zwingend zu Pflegen:
| Einstellung | Bedeutung |
|---|---|
| databases\rasServer | IP/URL zum Fernzugriffserver |
| databases\rasServerPorts | Port des Fernzugriffservers |
| databases\databaseServer | IP/URL zum Datenbankserver |
| databases\databaseAlias | Alias der Datenbank der bei der Einrichtung des Kontos in der DOCUframe-App angegeben werden kann. Der Alias darf keine Leerzeichen enthalten. (Seit Version 0.2.2 der DF-App ist der Alias optional und muss nicht mehr zwingend verwendet werden) |
| databases\userName | Benutzer den die RestApi zum Aufbau der Datenbankverbindung benutzet (Empfohlen: gsdwebservice) |
| databases\userPassword | Passwort des gsdwebservice-Benutzers als md5 Hash |
| databases\docuframeTmpDir | Absoluter Pfad zu einem Ordner für temporäre Dateien (z.B. C:\GSDDATA\RestApi\Temp, muss in Systemeinstellung _xRestAPI_TempPath genauso hinterlegt werden) |
| databases\tmpDir | Pfad zu einem Ordner für temporäre Dateien (läuft die RestApi auf einem anderen Server als DOCUframe dann selber Pfad als UNC-Pfad, z.B. \\Server\GSD_DATA\RestApi\Temp, ansonsten kann der Pfad aus docuframeTmpDir hier hinterlegt werden) |
| session\sessionTimeoutInSeconds | Timeout wie lange eine angemeldete Session aktiv bleibt, ist die Session abgelaufen muss beim nächsten Login die Datenbank erneut geöffnet werden. |
| listeners | Listener für Http, Http2 oder Https aktivieren und Port konfigurieren |
| encryption | Muss für die DOCUframe-App zwingend aktiviert werden |
| refreshLastLoggedIn | Muss für die DOCUframe-App zwingend aktiviert werden |
| checkService | Ist Checkservice aktiviert kann die DOCUframe-App bei Anlage des Kontos anzeigen ob die eingegebenen Daten korrekt sind |
Hinweise zur Einrichtung von Zertifikaten für SSL finden sie hier.
Sie können die getätigten Einstellungen auf Ihre Gültigkeit überprüfen, indem Sie die EXE-Datei erneut ausführen. In der Konsolenausgabe wird auf potenzielle Fehlerquellen aufmerksam gemacht.
Ist die Konfiguration erfolgreich kann die RestApi als Windows Dienst eingerichtet werden. Führen Sie dazu die beiliegende run-service.bat aus.
Ist die RestApi gestartet kann ein Aufruf über den Browser getestet werden.
z.B.: localhost:8081/_checkService
