Externe datasetattributen uit Rest-API

📘

Attributen ophalen uit een REST-API

GeoApps ondersteunt de mogelijkheid om attributen op te halen vanuit een REST-API welke op basis van json communiceert, waarbij één of meerdere attributen worden gebruikt voor het uitvoeren van een REST-request (zowel GET als POST is ondersteund). Deze attributen kunnen hierna gebruikt worden in bijvoorbeeld de pop-up voor het uitbreiden van de informatie van een dataset, zonder deze gegevens direct te moeten uploaden (bijvoorbeeld bij het gebruik van sensordata, een API met externe rekenregels, etc).

ook mogelijk caching functie te koppelen, op dit moment op basis van de api die gekoppeld dient te worden > maatwerk, neem contact op (screenshot toevoegen)

De configuratie van een externe databron bestaat uit drie onderdelen:

  • Het aanmaken van de externe databron
  • Het koppelen van attributen die meegestuurd worden naar de externe service
  • Het aanmaken van de attributen die opgehaald worden uit de externe databron

Aanmaken van externe databron

  1. Ga naar de gewenste dataset, en kies het tabblad External sources.
  2. Selecteer '+Add'.

Bij het aanmaken van het externe datasetattribuut dient aangegeven te worden welke URL geraadpleegd moet worden, of het een GET- of POST-aanroep is en of de resultaten gecached mogen worden door GeoApps en voor hoe lang.

  1. Vul de attribuutnaam van het bronattribuut in.
  2. Voeg de URL toe.
  3. Geef aan of het een GET- of POST-aanroep is. Gebruik GET als je data wil lezen zonder de status te veranderen en gebruik POST als je de status wilt kunnen aanpassen op de server.

Koppelen van attributen die verstuurd worden naar de externe databron

Na het aanmaken van de externe databron kunnen op de detailpagina attributen toegevoegd worden. Hierbij wordt de naam van de parameter opgegeven, met welk attribuut deze gevuld dient te worden uit de dataset en welke testwaarde gebruikt dient te worden. Ook kan worden aangegeven of het een tekstuele, numerieke of decimale waarde betreft, zodat deze correct wordt genoteerd in een json-bericht dat gebruikt wordt bij de POST.

Nadat de attributen correct geconfigureerd zijn, zal op de detailpagina onder 'Test result' het json-resultaat verschijnen van de aanroep op basis van de testwaarden. Hiermee kan geverifieerd worden of de koppeling correct tot stand gebracht is.

Aanmaken van de attributen die opgehaald worden uit de externe databron

Als laatste stap kunnen onder het tabblad Attributes één of meerdere attributen worden aangemaakt welke worden opgehaald uit de externe databron. Bij het aanmaken van een attribuut dient als Source gekozen te worden voor de aangemaakte databron uit stap 1. De naam die voor het attribuut gebruikt wordt dient overeen te komen met de parameter in het json-bestand die teruggestuurd wordt.