REST Api

Doormiddel van deze api kunnen gegevens uit de database van Almelo (2024) uitgelezen worden. Op deze pagina vindt u documentatie over de manier waarop u de gegevens kunt ophalen en welke data er wordt teruggegeven.

REST

De api makt gebruik van een REST protocol, dit is naar mening van velen een van de meest eenvoudige protocollen. U stuurt een verzoek naar deze server met de juiste methode (GET, POST, PUT of DELETE) om zo data te bewerken en uit te lezen.

Authenticatie

Algemeen

Hoewel de applicatie publiekelijk beschikbaar is dient er wel een api key meegestuurt te worden. Deze dient als parameter 'apikey' meegestuurt te worden bij iedere request.

http://www.uitinalmelo.nl/api/rest/locations?apikey=38459234y5wefcgejrkukju

Indien het toevoegen van parameters aan de url voor problemen zorgt, zoals bij het gebruik van frameworks. Kan er ook gekozen worden om een x-apikey header mee te sturen welke de apikey bevat.

x-apikey: 38459234y5wefcgejrkukju

Via onderstaand formulier kunt u een api-key aanvragen. U krijgt de api key direct, maar u kunt er pas gebruik van maken nadat deze is goedgekeurd.

Het Antwoord

Er zijn meerdere manieren wat betreft presentatie van de response, dit is gebaseerd op de 'Accept' header, als deze geset is op 'application/json' wordt de het antwoord geformat zoals gepresenteerd op de pagina methodes. Een andere methode is om de 'Accept' header op 'application/vnd.kama-v1+json' te setten, hierdoor wordt de response aangevuld met verschillende andere objecten zoals hieronder weergegeven.

Meta zal altijd de http responsecode bevatten. Daarnaast, mocht er iets fout zijn te gaan, of er gewoon wat te melden valt zal er een 'message' meegeleverd worden. Het 'debug' object helpt tijdens ontwikkelen en zal meegestuurd worden ten tijde van de testperiode van de applicatie, er kan dus niet vanuit gegaan worden dat deze altijd meegestuurt wordt. 'response' zal het object bevatten dat beschreven is op de pagina 'methodes'.

{
	'meta': {
	'code': 200
	'message': 'Oops' //Optioneel, alleen in geval van fout
},
'debug': {
...
},
'response': ..
}