Let op: dit is niet een actuele versie
Actuele versie: 01-09-2017

AERIUS Connect API - Handleiding

In het kort
Berekeningen met AERIUS Calculator kunnen worden uitgevoerd met een webservice. Deze webservice gaat uit van het websocket protocol. Dit protocol maakt berichtenverkeer in twee richtingen mogelijk over een internetverbinding. Het formaat voor de gegevensuitwisseling is JSON-RPC. Het websocket protocol, JSON-RPC, en de verschillende API functies worden hieronder nader toegelicht. Deze facstheets beschrijft AERIUS Connect API versie 1.

Websocket Protocol
Een webservice maakt gebruik van een communicatie protocol om te communiceren tussen gebruiker en server. AERIUS connect gebruikt hiervoor het websocket protocol. Dit protocol maakt berichtenverkeer in twee richtingen mogelijk over een internetverbinding. Daarnaast werkt het asynchroon en kunnen resultaten in een andere volgorde komen dan de volgorde van opdrachten, hiervoor wordt het id gebruikt om verzoek en antwoord weer aan elkaar te koppelen. Meer informatie over websocket is te vinden op www.websocket.org.

JSON-RPC
Boven op het websocket protocol communiceert de AERIUS connect API op basis van het JSON-RPC protocol. Het JSON-RPC protocol is een specificatie om in JSON (JavaScript Object Notation) RPC (remote procedure calls) uit te voeren. Hierbij wordt als het ware een functie aangeroepen die op de server wordt uitgevoerd. Het JSON-RPC protocol benoemt hoe functienaam, functie argumenten, resultaten en foutmeldingen moeten worden beschreven. Uitgebreidere informatie hierover kan worden gevonden op de website van JSON-RPC: http://www.jsonrpc.org/specification.

Functionaliteit AERIUS Connect API versie 1
Berekeningen met AERIUS Calculator kunnen worden uitgevoerd met een webservice: ws://connect.aerius.nl/connect/1/services

Voorbeelden aanvraag (request)
Conversie van GML bericht naar meest recente versie IMAER (1.0):

Toelichting velden:
jsonrpc: versie van jsonrpc protocol (altijd 2.0)
id: betreft een uniek door de gebruiker aangeleverd nummer
method: de aan te roepen methode
file-name: bestandsnaam. De extensies PDF GML en CSV worden ondersteund. Het bronbestand wordt naar GML geconverteerd
file-data: Het data block is een base 64 encoding van het bestand

Rekenopdracht:

Toelichting velden:
jsonrpc: versie van jsonrpc protocol (altijd 2.0)
id: betreft een uniek door de gebruiker aangeleverd nummer
method: de aan te roepen methode
file-name: bestandsnaam. De extensies PDF GML en CSV worden ondersteund. Het bronbestand wordt naar GML geconverteerd
file-data: Het data block is een base 64 encoding van het bestand
options-year: rekenjaar
options-calculationType: mogelijke opties zijn [NATURE_AREA | RADIUS | CUSTOM_POINTS | PERMIT]
options-substances: stoffen waar voor gerekend kan worden (NOX en/of NH3)
options-maximumRange: afstand in meters
options-tempProject: betreft het een tijdelijk project? (0=nee en 1=ja)
options-tempProjectYears: aantal jaren waarin project wordt uitgevoerd (1-5 jaar)
options-email: email adres gebruiker voor verzending resultaten rekenopdracht
options-reference: door de gebruiker gekozen referentietekst voor in het onderwerp van de email
options-listener: door de gebruiker gekozen referentie nummer

Resultaat rekenopdracht
De webservice geeft een melding wanneer de rekenopdracht is aangeboden aan AERIUS Calculator. De gebruiker kan dan de verbinding verbreken. Wanneer de rekenopdracht is afgerond, ontvangt de gebruiker een email. De email bevat een downloadlink die gebruikt kan worden om de rekenresultaten te downloaden.

Gerelateerde factsheets

Factsheet

Factsheet
639-2958
Voor
  • Connect
Type
Algemeen