Swagger
Swagger ist eine Open-Source Werkzeugsammlung, um HTTP-Webservices zu erstellen, zu dokumentieren und zu nutzen. In der mit der SelectLine API mitgelieferten Installation, dient Swagger als Test- und Dokumentationsumgebung.
Mit jeder Installation der API wird auch die zu dieser Version zugehörige Hilfe inkl. Swagger installiert.
- Wenn Sie den Link zur Hilfeseite nicht kennen, öffnen Sie den Mobile Manager --> Seite Webseite die Hilfe aufrufen - "...api/help".
- Unter Grundlagen - Swagger wählen --> "Swagger-Dokumentation und Testumgebung" auswählen.
Fasst alle Funktionen der API erfordern eine Anmeldung / einen gültigen Token. Wenn Sie bereits in Ihrer Anwendung eine Anmeldung implementiert haben und einen gültigen Token zurückerhalten, können Sie diesen für Testzwecke auch direkt in Swagger einsetzen und brauchen sich hier nicht erneut anmelden.
- Um sich per Swagger anzumelden, wählen Sie "Account", öffnen dann "POST/Login" und klicken oben rechts auf "Try it out".
- Daten in der Benutzeranmeldung eingeben ("Appkey" entfernen, wenn nicht vorhanden) --> Excecute.
- Wenn erfolgreich "AccessToken" aus dem Response kopieren, nach ganz oben scrollen --> "Authorize" klicken und Token einfügen --> "Authorize" klicken.
Abfragen können in der Regel direkt durchgeführt werden und liefern somit die ersten Ergebnisse. Wichtig zu wissen ist, dass beim Abfragen mehrerer Datensätze immer nur die ersten 10 zurückgegeben werden, wenn keine Anzahl definiert wurde.
- Wählen Sie "Article" --> "GET/Articles" öffnen und oben rechts "Try it out" klicken.
- Wenn gewünscht, Filtereinträge setzen --> "Execute" klicken.
- Im Response ist das Ergebnis zu lesen.