API-Dokumentation auf Basis von Swagger

API-Dokumentation auf Basis von Swagger

Sie können unsere API mit Hilfe von Swagger live ausprobieren.

API-Dokumentation öffnen

Nehmen wir an ein "normaler" Nutzer interagiert mit der Software über die Webadresse https://demo.aptecloud.valucon.de
Die API-Dokumentation lässt sich dann über https://demo.api.aptecloud.valucon.de/api-docs/index.html öffnen: beachten sie das Wort "api" im vorderen Teil der Webadresse.
Zum Öffnen der API-Dokumentation benötigen Sie Nutzername und Passwort: beides teilen wir Ihnen gerne auf Anfrage mit.

Vorbereitende Schritte, damit die API live genutzt werden kann

Das Video zeigt die vorbereitenden Schritte im Detail. Im Folgenden werden stichwortartig die Schritte kurz angerissen:

Unter defaultHost eintragen: demo.api.aptecloud.valucon.de (bitte ersetzen durch Ihre Webadresse!)
Authorize klicken/Try it out klicken
Email und Passwort eintragen - dazu "string" entsprechend ersetzen
Execute klicken
authentification_token herauskopien
Authorize erneut klicken
- auth_tocken (apiKey): den unter Schritt 5 kopierten Token hineinkopieren und authorize klicken
- auth_email (apiKey): E-Mail-Adresse hineinkopieren und authorize klicken

Jetzt können Sie die API live nutzen.

Note	Wenn Sie die Swagger-Seite schließen, erlischt die Authorisierung. D. h. beim erneuten Öffnen der Swagger-Seite müssen Sie die Authorisierung neu durchführen.