Swagger (REST-API Online Dokumentation) – Hilfe-Center

Bitte beachten Sie folgendes, dass die Seite auf dem IIS mit HTTPS eingerichtet sein muss. Binding HTTPS und ein gültiges Zertifikat. Für Testsysteme dürfen Sie Self Signed Zertifikate verwenden. Für Produktive Systeme muss ein offizielles Zertifikat verwendet werden. Achten Sie auf den Issuer Name. Die Seite wird nur korrekt angezeigt, wenn das Zertifikat mit dem Issuer und der URL übereinstimmt.

Das Zusammenspiel URL, Zertifikat sieht wie folgt aus:

Zertifikat

IIS Server Zertifikat

IIS HTTPS Binding

Url

Swagger ist eine Schnittstellendokumentation, welche alle verfügbaren Ressourcen aufzeigt und gleichzeitig dessen «LIVE» Ausführung erlaubt.

Um Swagger zu verwenden, müssen Sie zuerst einen Infoniqa ONE 200 Benutzer mit Infoniqa Cloud Identity verknüpfen. Bitte lesen Sie dazu den Abschnitt Infoniqa Cloud Identity.

Swagger Redirect URL

Damit Sie die Anmeldung beim Swagger korrekt abschliessen können, müssen Sie uns noch die folgenden Informationen per E-Mail (OrderSchweiz@infoniqa.com) mitteilen.

Beispiel-Mailtext:

«Vollqualifizierter Domainname: mypc.dev.local
Webseite, welche Sie bei der Installation angegeben haben: API
Produkt: Infoniqa Produktname (Infoniqa 50 oder Infoniqa ONE 200)»

Sobald wir die Angaben eingetragen haben, teilen wir Ihnen diese mit. Wenn Sie die Redirect URL von uns erhalten haben, gehen Sie bitte wie folgt vor:

Wechseln Sie in den Ordner wo die REST-Api installiert wurde. Am besten über den IIS und im Context Menue «Im Explorer öffnen» auswhälen.
Im File Explorer die Datei appsettings.json auswählen und im Editor öffnen.
Tragen Sie nun im json File die URL beim Element SCI => InternalRedirect ein.

Speichern Sie die Datei und starten Sie ggf. den IIS neu.

Danach sind Sie in der Lage, sich auf der Swagger Seite mit dem verknüpften SCI Benutzer anzumelden.

Authentifizierung

Um die Ressourcen ausführen zu können, müssen man sich mit seiner E-Mail-Adresse anmelden. Dazu wird die Schaltfläche «Authorize» betätigt.

Es wird ein kleines Fenster mit den verfügbaren Autorisierungen angezeigt.

In diesem Fall wird das Kontrollkästchen «readwrite_access / Allow to read/write» aktiviert und mit «Authorize» bestätigt. Es wird das Infoniqa Cloud Identity Fenster geöffnet. Hier fährt man mit der registrierten E-Mail-Adresse weiter.