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" als 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:

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

Schritt 6 sorgt dafür, dass das authentication_token und die E-Mail gespeichert und jedem API-Request hinzugefügt werden. Dies stellt sicher, dass der Benutzer als eingeloggt erkannt wird.

Ab jetzt können Sie die API live über die Swagger-Webseite testen.

cURL

Bei CURL-Aufrufen müssen jedem Request die Header x-user-token und x-user-email hinzugefügt werden. Beispiel:

-H 'x-user-token: 2jCbAwesp9d2s44UM5C1' -H 'x-user-email: test.user@demo.de'

Authorisierung erlöscht, wenn Sie die Seite schließen

• 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.