Das Setup führt Sie durch den Installationsprozess für ein Produktivsystem oder Testsystem. Dabei sind die beiden Begriffe Produktivsystem und Testsystem wie folgt definiert:
Produktivsystem
Beim produktiven System wird die REST-API auf einen Server installiert. Swagger ist aus Sicherheitssicht ausgeschaltet und darf auf einem produktiven System nicht aktiviert sein. Lesen Sie später mehr im Abschnitt sicherheitsrelevante Punkte.
Testsystem
Ein Testsystem ist für einen Entwickler, damit er seine Applikation für die Nutzung der REST-API erstellen kann. Bei einem Testsystem ist Swagger eingeschaltet. Swagger bietet eine Dokumentation über alle Ressourcen und zeigt, welche Operationen auf welchen Ressourcen ausgeführt werden können. Mittels Auto REST kann auf die JSON-Definition-Datei zugegriffen werden, welche man über Swagger aufrufen kann. Mit Auto REST können die Model Klassen und die entsprechenden Methoden generiert werden.
Setup
Wenn Sie nun das Setup ausführen, wird zuerst geprüft, ob auf dem System die Prerequisites vorhanden sind. Wenn nicht, erscheint gleich nach dem Start der folgende Dialog.
Wenn Sie nun Install ausführen, werden die Prerequisites auf dem System installiert. Nach erfolgreicher Installation erscheint der folgende Screen.
Drücken Sie nun auf Next und akzeptieren Sie die Lizenzbestimmungen.
Danach erscheint die Information über den Auftragsverarbeitungsvertrag, welcher Sie ebenfalls akzeptieren müssen.
Danach geben Sie Ihr Benutzer- und Firmenname ein.
Danach sehen Sie die Auswahl betreffend dem Zielsystem. Wählen Sie ein System gemäss der Definition (Produktivsystem / Testsystem) von oben aus.
Folgen Sie nun, je nachdem welches System Sie ausgewählt haben, im entsprechen Abschnitt fort.
Installation Testsystem
Wenn Sie den vorhergehenden Schritten im Abschnitt Setup durchgeführt und das Testsystem ausgewählt haben, erscheint der folgende Dialog.
Complete
Installiert die Finance (Finanz), die Operations (Auftrag) und die Payroll (Personal) API.
Custom
Mit der Auswahl Custom haben Sie auf dem nächsten Dialog die Möglichkeit, eine der APIs (Finance / Operations / Payroll) zu installieren.
Wenn Sie nun auf Weiter drücken, erscheint der Dialog, um den Datenbank Server anzugeben, auf welchem die Instanz läuft. Diese werden verwendet, um die REST-API Schnittstelle mit der Datenbank zu verbinden.
Im nächsten Schritt geben Sie den Webseitenname an, unter welchem die REST-API auf dem IIS installiert werden soll.
Wenn Sie der den Namen definiert haben, drücken Sie auf Next.
Dies ist der letzte Dialog, welcher vor der Installation erscheint. Falls Sie noch Änderungen vornehmen möchten, können Sie mit Back zurück.
Die Installation beginnt und installiert die gewählten Komponenten auf ihrem System.
Sobald die Installation fertig ist, erscheint der Abschlussbildschirm und Ihre REST-API ist auf dem System installiert.
Mit dem Link «Online Help» gelangen Sie auf die Webseite, welche weitere Informationen über die REST-API enthält. Mit dem Link «API-Dokumentation (Swagger)» rufen Sie die eben installierte REST-API mit dem Swagger auf.
Installation Produktivsystem
Wenn Sie den vorhergehenden Schritten im Abschnitt Installation durchgeführt und das Produktivsystem ausgewählt haben, erscheint der folgende Dialog.
Complete
Installiert die Finance (Finanz), die Operations (Auftrag) und die Payroll (Personal) API.
Custom
Mit der Auswahl Custom haben Sie auf dem nächsten Dialog die Möglichkeit, eine der APIs (Finance / Operations / Payroll) zu installieren.
Wenn Sie nun auf Weiter drücken, erscheint der Dialog, um den Datenbank Server anzugeben, auf welchem die Instanz läuft. Diese werden verwendet, um die REST-API Schnittstelle mit der Datenbank zu verbinden.
Im nächsten Schritt geben Sie den Webseitenname an, unter welchem die REST-API auf dem IIS installiert werden soll.
Wenn Sie der den Namen definiert haben, drücken Sie auf Next.
Dies ist der letzte Dialog, welcher vor der Installation erscheint. Falls Sie noch Änderungen vornehmen möchten, können Sie mit Back zurück.
Die Installation beginnt und installiert die gewählten Komponenten auf ihrem System.
Sobald die Installation fertig ist, erscheint der Abschlussbildschirm und Ihre REST-API ist auf dem produktiven System installiert.
Mit dem Link «Online Help» gelangen Sie auf die Webseite, welche alle Informationen über die REST-API enthält.
Wichtige Punkte zur Installation
Hier noch einige wichtige Punkte zur Installation:
-
Bei der Installation muss der IIS mit einem HTTPS Binding konfiguriert sein. Es ist nur erlaubt, die REST-API unter HTTPS laufen zu lassen. Für produktive Umgebungen müssen unbedingt offizielle Zertifikate verwendet werden. Keine Self Signed Zertifikate.
-
Bitte installieren Sie nur eine REST-API pro Datenbank. Mehrere REST-APIs auf einer Datenbank führen zu Konflikten und es funktioniert nur die zuletzt installierte Version.
-
Um sich mit Swagger bei Cloud Identity anzumelden, müssen Sie die korrekte Redirect-URL, der Firma mitteilen. Lesen Sie dazu das Kapitel Cloud Identity.
-
Lesen Sie den Abschnitt Sicherheitsrelevante Punkte durch.
-
Genauere Informationen über die Verknüpfung Benutzer mit Cloud Identity finden Sie im Abschnitt Cloud Identity. Die Cloud Identity und REST-API sind basierend auf Auth0. Sie finden Beispiele und weitere Informationen unter https://auth0.com.
-
Genauere Informationen über Swagger finden Sie im Abschnitt Swagger (REST-API Online Dokumentation).