Doku

Die komplette Schnittstellendefinition ist über <Url>/swagger abrufbar. Die Projekt-Api ist in einer separaten Definition gekapselt:

Schema

In den Schemadaten werden die Entitäten und Felder beschrieben. Dort ist ebenfalls das Mapping zu den VinX-Feldnamen zu finden, falls vorhanden:

Die Namensgebung der Felder folgt bei Fremdschlüsseln (FK) soweit als möglich der Namenskonvention <Referent-Entität>Id. 

Beipiel: "priceGroupId": Dies ist ein Fremdschlüssel zur Entität "PriceGroup". 

Authorisierung

Der Swagger-Endpunkt selbst verlangt Basic Authentication, wobei für Benutzer/Pwd dieselben Werte wie für den Token-Request verwendet werden können.

Für den Zugriff auf die Api aus Swagger muss der Authentifizierungs-Header gesetzt werden. Dabei muss dem Token der Wert "Bearer" wie im folgenden Screenshot vorangesetzt werden:

Demo-Server

Unter https://vinxapi.i-ag.ch/swagger ist ein Demo-Server mit dem aktuellsten Stand verfügbar. Die Zugangsdaten können unter support@i-ag.ch angefragt werden. 

Die Daten des Demo-Servers werden jede Nacht zurückgestellt.