Beheer

Webservice

Chris Kettenis 2021-03-02 09:46:41
Een deel van de functionaliteit van BIVAS kan beschikbaar worden gemaakt via een webservice.

Om BIVAS vanuit andere applicaties te kunnen benaderen en gebruiken is er een webservice ingebouwd. Via de webservice kunnen de volgende acties worden uitgevoerd:

  • Kopieren bestaande scenario’s.
  • Instellen simpele paramaters van scenario’s.
  • Instellen te bepalen statistieken en het starten van berekeningen daarvoor.
  • Ophalen resulterende statistieken (beperkt tot vier types).
  • Invoeren Waterscenario’s.

In de applicatie staat de webservice standaard uit. De webservice kan worden geconfigureerd door in het configuratiebestand de regel <WebService Active="True" Ip="127.0.0.1" Port="80"/> de waarde van “Active” op “True” te zetten. Verder dient het ingestelde IP bereikbaar te zijn vanaf de locatie vanaf waar de API calls gestuurd worden. Deze geconfigureerde instellingen zullen dan bij de eerstvolgende keer opstarten worden meegnomen.

API Handleiding

De handleiding en een testpakket valt vanaf hier te downloaden: Bivas 4.4.0 API.zip.

Deze bestaat uit een handleiding, waarin een overzicht staat van alle mogelijke eindpunten, hoe deze te gebruiken en wat de verschillende responses hierbij betekenen. Verder heeft dit bestand een map met batchbestanden. Als het bestand "Initialize.bat" wordt uitgevoerd op BIVAS met een nieuwe (uit BIVAS 4.4.0 geimporteerde) database, dan zal deze met behulp van het programma cURL naar de mogelijke API eindpunten een request sturen , welke (foutloos) worden afgehandeld. Deze requests kunnen als voorbeeld gebruikt worden bij het zelf samenstellen van requests.