Die Dokumentation der AMPAREX Rest API steht per Swagger-UI zur Verfügung und ist gleichzeitig ein Testwerkzeug, um sich mit der API vertraut zu machen. API-Funktionen können über das Swagger-UI direkt aufgerufen werden. Hierbei werden Livedaten ausgeliefert. Das zugrundeliegende Swagger Framework ist ein Open-Source-Software-Framework, um RESTful Webservices zu entwerfen, zu erstellen, zu dokumentieren und zu nutzen.
URL
Die Swagger-UI kann auf allen AMPAREX Testservern unter folgender URL aufgerufen werden:
https://<host>:8078/amparex/webaxapi/swagger-ui.html
Die Swagger Oberfläche steht aus Sicherheitsgründen nur auf Testsystemen zur Verfügung. Falls noch kein Testsystem zur Verfügung steht, wenden Sie sich an den AMPAREX Support. |
Oberfläche
Die Dokumentation wird im Browser wie folgt angezeigt:
