Skip to content

Database API

Om jouw data toe te kunnen voegen aan de database maak je gebruik van een REST API. Op deze pagina vind je alle informatie die je nodig hebt om deze te kunnen gebruiken.

Om gebruik te kunnen maken van de database heb je een API-key nodig. Deze kan je zelf verkrijgen via DLO.

Meting toevoegen

Met deze API call kan je een meting die jij hebt gedaan opslaan in de database. Je mag één meting per 10 minuten opslaan.

POST http://hva-onto.nl/api/ti/map/measurements/add
Attribuut Parameter/Body Type Verplicht Omschrijving
api-key parameter string ja Om te laten weten wie jij bent moet je je API-key meesturen.
type body string ja Type van de waarde (keuze uit: temperature, light, humidity of co2)
value body string ja De gemeten waarde

Wanneer jouw waarde is toegevoegd aan de database krijg je het volgende antwoord terug:

{
    "success": true,
    "message": "Measurement created."
}

Wanneer er wat fout gaat, bijvoorbeeld door een foutieve api-key of als je vaker dan eens per 10 minuten een waarde wilt opslaan kan je het volgende resultaat terug krijgen:

{
    "success": false,
    "message": "No api key provided."
}




Metingen ophalen

Met deze API call kan je een lijst krijgen van alle metingen die zijn opgeslagen door jou. De metingen zijn gesorteerd op meest recent naar oud.

GET http://hva-onto.nl/api/ti/map/measurements/list
Attribuut Parameter/Body Type Verplicht Omschrijving
api-key parameter string ja Om te laten weten wie jij bent moet je je API-key meesturen.

Wanneer je een geldige API key meestuurt krijg je het volgende resultaat terug:

{
    "success": true,
    "measurements": [
        {
            "date": "2023-10-03 15:45:10",
            "type": "temperature",
            "value": 19.1,
        },
        {
            "date": "2023-10-01 10:16:00",
            "type": "temperature",
            "value": 14.8,
        }
    ]
}

Wanneer er wat fout gaat, bijvoorbeeld door een foutieve api-key kan je het volgende resultaat terug krijgen:

{
    "success": false,
    "message": "Invalid api key."
}




Kaart tonen

Met deze API call krijg je een PNG-afbeelding terug met een landkaart van Nederland met hierop markeringen met temperaturen.

GET http://hva-onto.nl/api/ti/map
Attribuut Parameter/Body Type Verplicht Omschrijving

Met HTML kan je deze ‘embedden’ in jouw eigen webpagina:

<img src="http://hva-onto.nl/api/ti/map" />