HooikoortsALERT.nl stopt. Wij staken onze dienstverlening. Lees meer

API documentatie

De API bevindt zich op de url http://api.hooikoortsalert.nl . Er kan een aanvraag naar de API worden verstuurt door middel van een HTTP GET request. Hierbij dienen een aantal variabelen te worden opgegeven. Welke variabelen ziet u in het onderstaande tabel.

VariabelVerplichtOmschrijving
loginNeeDient "true" te zijn voor deze manier van aanvragen. Als de variabel niet wordt meegegeven wordt aangenomen dat het "true" is.
usernameJaUw gebruikersnaam ter authenticatie.
keyJaUw API key ter authenticatie.
hostJaDe domeinnaam van de website die de aanvraag doet. Dit wordt bijgehouden voor statistieken en om misbruik te voorkomen. Als u de API voor een desktopapplicatie gebruikt is het toegestaan om de naam van de applicatie in dit veld te vermelden.

Een voorbeeld van wat een geldige URL waarop een aanvraag wordt gedaan zou kunnen zijn: http://api.hooikoortsalert.nl/?login=true&host=www.hooikoortsalert.nl&username=janmetdepet&key=XXXX008456

De API zal vervolgens een XML-document als antwoord geven. Als er geen fouten zijn opgetreden zal dit XML-document er als volgt uitzien:

Zijn er wel fouten opgetreden, dan zal het XML-document er als volgt uitzien. Een uitleg van de elementen staat onder de afbeelding.

Uitleg van de elementen

VariabelTypeMogelijke waardenOmschrijving
timestampInt-Bevat de UNIX timestamp van het antwoord.
successStringyes, noyes bij succes, no als er fouten zijn opgetreden. Zie verderop in deze uitleg.
intInt1, 2, 3, 4, 5, 6Bevat de hooikoortssitatie in de vorm van een cijfer. Zie het tabel verderop voor de betekenis van de waarden. Dit element bestaat alleen als er geen fouten zijn opgetreden.
txtString(Zie verderop)Bevat de hooikoortssitatie in de vorm van een voor programmeertalen goed verwerkbare tekst. Zie het tabel verder voor de verschillende waarden en betekenissen. Dit element bestaat alleen als er geen fouten zijn opgetreden.
descString(Zie verderop)Bevat de hooikoortssitatie in de vorm van een leesbare tekst die in princiepe zo kan worden weergegeven. Zie het tabel verder voor de verschillende waarden. Dit element bestaat alleen als er geen fouten zijn opgetreden.
usernameString-Bevat de gebruikersnaam zoals deze aan de API is doorgegeven. Dit element bestaat alleen als er fouten zijn opgetreden.
keyString-Bevat de API key zoals deze aan de API is doorgegeven. Dit element bestaat alleen als er fouten zijn opgetreden.
hostnameString-Bevat de domeinnaam waar de aanvraag vandaan komt zoals deze aan de API is doorgegeven. Dit element bestaat alleen als er fouten zijn opgetreden.
ipString-Bevat het IP-adres van de server waar de aanvraag vandaan komt. Dit element bestaat alleen als er fouten zijn opgetreden.
occurredStringyesAls dit element bestaat, betekent dit dat er fouten zijn opgetreden.
codeInt(Zie verderop)Als er fouten zijn opgetreden bevat dit element de foutcode.
messageString(Zie verderop)Als er fouten zijn opgetreden bevat dit element een beschrijving van de fout.


Foutcodes

De API kan verschillende foutcodes teruggeven. In het onderstaande tabel staan alle foutcodes en wat ze betekenen.

FoutcodeOmschrijving
110Uw logingegevens zijn incorrect.
120U heeft de domeinnaam (host) niet opgegeven.
250Uw logingegevens zijn geblokkeerd.
510Er is een fout opgetreden in het systeem van HooikoortsALERT.nl. Hierdoor is de API momenteel niet beschikbaar.
520Er wordt momenteel onderhoud uitgevoerd aan het systeem van HooikoortsALERT.nl. Hierdoor is de API momenteel niet beschikbaar.
530Er is een fout opgetreden in het systeem van HooikoortsALERT.nl. Hierdoor is de API momenteel niet beschikbaar.
550Er is een fout opgetreden in het systeem van HooikoortsALERT.nl. Hierdoor is de API momenteel niet beschikbaar.


Hooikoortssituaties

In deze tabel vindt u een overzicht van de verschillende hooikoortssiutaties die HooikoortsALERT.nl kent en hoe deze door de API worden weergegeven.

inttxtdesc
1zeer-gunstigZeer gunstig
2gunstigGunstig
3tamelijk-gunstigTamelijk gunstig
4tamelijk-ongunstigTamelijk ongunstig
5ongunstigOngunstig
6zeer-ongunstigZeer ongunstig


Gegevens en uitleg

De gegevens die u nodig heeft voor het gebruik van deze API, vindt u op deze pagina. Als u nog vragen heeft over de API of u komt er met uw implementatie niet uit, neemt u dan gerust contact met ons op. Onze contactgegevens zijn hier te vinden.