Swagger (REST-API Online Dokumentation)

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 ONE 50 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 ([e-mail]) mitteilen.

Beispiel-Mailtext:

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

Sobald wir die Angaben eingetragen haben, teilen wir Ihnen diese mit.

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.

Ressourcen Übersicht

Auf der Hauptseite sind die verfügbaren Ressourcen ersichtlich.

Im unteren Bereich werden die verschiedenen Schemas angezeigt.

Um eine bestimmte Ressource zu verwenden, klickt man auf die dazugehörige Überschrift (Beispiel Kreditor).

Links wird angezeigt, um welche Funktionalität es sich handelt:

• GET (Lesen)

• POST (Schreiben/Hinzufügen)

Rechts wird der Methodenname dargestellt.

Ressourcen Aufruf

Die entsprechende Funktion klicken und mittels «Try it out» gelangt man in den «Ausführung Modus».

Die benötigten Parameter abfüllen und «Execute» betätigen.

Im «Response» Bereich wird das Resultat im JSON Format zurückgegeben.

Dazugehöriges Model: