REST Service

In GeolinQ kunnen REST services worden geconfigureerd waarmee opgeslagen gegevens direct kunnen worden benaderd en bewerkt. Via de REST services kan potentieel elke applicatie de gegevens in GeolinQ benaderen en bewerken volgens configureerbare HTTP requests en configureerbare response formaten zoals JSON, XML en GML. De geconfigureerde REST interface kan worden geëxporteerd in de OpenAPI Specification (OAS) zodat de documentatie van de configureerde REST service direct beschikbaar is voor ontwikkelaars. Met de configureerbare REST services sluit GeolinQ aan op de ontwikkelingen van gegevensuitwisseling van de Nederlandse overheid. De overheid heeft steeds vaker de voorkeur voor gegevensuitwisseling via REST API’s en OAS als documentatiestandaard voor REST API’s.

Configureerbare REST service

De REST service van GeolinQ bestaat uit configureerbare HTTP requests of ook wel REST endpoints genoemd. Voor een REST endpoint kunnen in GeolinQ de HTTP methode (POST, PUT, GET enz.), de URL parameters en query parameters worden geconfigureerd. De URL en query parameters kunnen direct aan attributen van de datasets worden gekoppeld. Voor het request of de response van het endpoint kunnen JSON of XML formaten aan het endpoint worden gekoppeld. De import- en exportformaten zijn volledig configureerbaar en zijn aan GeolinQ datasets gekoppeld zodat de gegevens in GeolinQ in elke denkbaar formaat opgehaald en bewerkt kunnen worden.

OpenAPI Specification (OAS)

De documentatie of beschrijving van een REST API is van groot belang voor ontwikkelaars die met de REST API willen koppelen. De OpenAPI Specification (OAS) biedt een standaard voor het documenteren van een REST API. De configuratie van een GeolinQ REST service kan worden geëxporteerd als OAS 3.0 tekstbestand met een gestandaardiseerde YAML of JSON structuur. Elke geconfigureerde GeolinQ REST service is hiermee dus direct gedocumenteerd en klaar voor gebruik.