AERIUS Connect 2019
Releasedatum: 16-09-2019
Index
Algemeen
Connect API - in het kort
In het kort
AERIUS stelt een API (Application Programming Interface) beschikbaar aan ontwikkelaars, waarmee zij via een computer interface (API) opdrachten kunnen uitvoeren op de AERIUS Calculator, zonder gebruik te maken van een gebruikersomgeving (GUI). Voor de AERIUS Connect API betreft het opdrachten voor het valideren, converteren en rekenen met AERIUS Calculator.
Wat is een API?
API staat voor Application Programming Interface. Een API maakt het mogelijk om afzonderlijke softwareprogramma's of -onderdelen met elkaar te laten communiceren. Het is een software-naar-software interface, onzichtbaar voor gebruikers, en biedt daarom per definitie geen gebruikersomgeving (GUI).
Software-ontwikkelaars kunnen met behulp van een API programmeercode en/of gegevens uitwisselen. De benodigde code wordt uitgevoerd op de server van de AERIUS, die het resultaat vervolgens naar de client stuurt. Op het internet hebben API's meestal als doel om gebruikers (zoals web-ontwikkelaars) toegang te geven tot een aantal voorgedefinieerde procedures, zoals het ophalen, bewerken of opslaan van bepaalde gegevens.
Wanneer API gebruiken?
Het gebruik van de API voor AERIUS Calculator biedt o.a voordelen in de volgende situaties. Dit zijn slechts enkele voorbeelden en zeker niet uitputtend:
- De API is geoptimaliseerd voor grotere berekeningen doorrekenen van IMAER GML's die de ingestelde limieten van AERIUS Calculator overschrijden (bijv. maximaal aantal bronnen).
- Direct vanuit eigen client applicatie (bijv. eigen GIS) communiceren met de AERIUS Calculator
- Inrichten van een intern werkproces voor het uitvoeren van AERIUS berekeningen en verwerken van de resultaten in de organisatie-eigen applicatie architectuur.
- Web services zijn eenvoudig: web services zijn te gebruiken door software-ontwikkelaars.
Gerelateerde factsheets
Factsheet
Connect API - Handleiding
In het kort
Berekeningen met AERIUS Calculator kunnen worden uitgevoerd met een webservice. Deze webservice gaat uit van het HTTP REST protocol. Het formaat voor de gegevensuitwisseling is JSON. De verschillende API functies worden op de AERIUS Connect API documentatie pagina verder toegelicht.
Gerelateerde factsheets
Factsheet
Connect API of Calculator
In het kort
Rekenopdrachten met AERIUS Calculator kunnen worden uitgevoerd via de gebruikersomgveing (GUI) van Calculator, maar ook via de AERIUS Connect API. Via de AERIUS Connect API kunnen direct opdrachten (valideren, converteren, en rekenen) uitgevoerd worden op het rekenhart van AERIUS Calculator. De data en methodieken achter Connect en Calculator zijn gelijk.
Ten opzicht van gebruik van de GUI biedt de AERIUS Connect API een aantal aanvullende functionaliteiten.
Toepassing Connect API vs Calculator
Hieronder eerst een schematisch overzicht van het toepassingsbereik van AERIUS Calculator vs de AERIUS Connect API. Daaronder volgt een nadere toelichting.
| Calculator vs Connect | Calculator | Connect API |
|---|---|---|
| Grootschalige projecten | < ong. 250 bronnen | > ong. 250 bronnen |
| Rekenresultaat opgesplitst naar sector | Ja | Ja |
| Bepalen hoogste bijdrage van twee bronbestanden | Nee | Ja |
| IMAER validatie-service | Nee | Ja |
| IMAER conversie-service | Nee | Ja |
| GML’s combineren en als 1 set doorrekenen | Nee | Ja |
| ZIP in – ZIP uit (max. 1 bestand tbv comprimeren omvang) | Nee, alleen ZIP in | Ja |
| GML terugkrijgen uit AERIUS PDF | Moeilijk | Ja |
|
Directe communicatie vanuit eigen IT-systeem met rekenhart AERIUS Calculator |
Nee |
Ja |
- Grootschalige projecten: de Connect API is geoptimaliseerd voor het valideren, converteren en doorrekenen van grootschalige projecten en plannen die de ingestelde limieten van AERIUS Calculator te boven gaan. Denk aan initiatieven zoals de aanleg van snelwegen en bedrijventerreinen. Dit is mogelijk door het ontbreken van een userinterface.
- Rekenresultaat opgesplitst naar secor. De rekenresultaten worden ook per sector in de GML opgenomen.
- Bepalen hoogste bijdrage van twee bronbestanden. Op basis van meerdere invoer resultaatbestanden wordt een nieuw resultaat bestand gemaakt door van elke gevonden resultaat punt de hoogste waarde te nemen. Telt dus niet de resultaten op, maar bepaald hoogste waarde.
- IMAER Validatie-service: Technische validatie van een IMAER GML. Dat gebeurt in principe ook als je een GML importeert in AERIUS Calculator. Voordeel van de Connect API is dat je die zodanig kunt aansturen dat je meerdere GML’s kunt valideren.
- IMAER Conversie-service: Oudere versies (vanaf 1.0) van IMAER GML’s worden omgezet naar de meest actuele IMAER versie. Dat gebeurt in principe ook als je een GML importeert in AERIUS Calculator. Voordeel van de Connect API is dat je die zodanig kunt aansturen dat je meerdere GML’s kunt converteren.
- GML’s combineren tot 1 set van bronnen in 1 keer doorrekenen: Meerdere GML’s kunnen als 1 set van bronnen in 1 keer doorgerekend worden. Als resultaat ontvang je vervolgens één GML met alle bronnen uit de verschillende invoer GML’s en de daarbij horende totale emissies van alle bronnen
- Zip in is Zip uit. Dit biedt als grote voordeel dat de omvang van het dataverkeer aan de Client kant geminimaliseerd wordt. Dus m.n. handige bij een groot GML bestand. LET OP! Slechts 1 bestand uit de ZIP wordt gevalideerd en geconverteerd, NIET meerdere. Tenzij het een PDF is met 2 situaties.
- GML terugkrijgen uit AERIUS PDF. Het converteren van een AERIUS PDF – via de conversie service- resulteert in een losse IMAER GML. Op die manier is het mogelijk om op eenvoudige wijze losse GML’s te genereren die zijn opgenomen in een AERIUS PDF. Die GML kan vervolgens weer bewerkt worden en opnieuw aangeboden worden.
- Directe communicatie vanuit eigen client applicatie (bijv. eigen GIS) communiceren met het rekenhart van AERIUS Calculator. Resultaten van een AERIUS validatie, conversie, en berekening kunnen direct in het eigen IT-Systeem bekeken, geanalyseerd en gecombineerd worden met eigen databronnen.