API / Export handleiding
Handleiding API en export
Met de API- en exportdienst kun je P2000-meldingen automatisch ophalen via persoonlijke feedlinks of handmatig downloaden via het exportportaal. De beschikbare regio’s, formaten, limieten en filters hangen af van de rechten die door de beheerder zijn ingesteld.
Wat krijg je na goedkeuring?
Persoonlijke feedlinks
Voor JSON, XML en RSS krijg je eigen links met een persoonlijk token. Deze links geven alleen meldingen terug binnen jouw ingestelde rechten.
Geavanceerde JSON API
Via de query-variant kun je extra filters meegeven, zoals regio, plaats, prioriteit, hulpdienst, zoekwoord en limiet.
Exportportaal
Als export is toegestaan, kun je zelf CSV-, Excel- of PDF-bestanden maken binnen de ingestelde periode, regio’s en limieten.
Belangrijk: deel je links niet openbaar
Iedere API-link bevat een persoonlijk token. Iedereen met die link kan binnen jouw rechten data ophalen. Deel deze links daarom niet openbaar op websites, forums, GitHub, social media of in openbare documentatie.
Misbruik of openbaar delen
Bij misbruik, ongebruikelijk zwaar gebruik of het openbaar delen van API- of exportlinks kan de toegang tijdelijk of definitief worden geblokkeerd. Dit geldt ook wanneer een persoonlijk token door derden wordt gebruikt of wanneer de dienst onnodig zwaar wordt belast.
Vaste feedlinks
De vaste feedlinks zijn bedoeld voor eenvoudige koppelingen. Je hoeft geen extra parameters mee te geven. De feed gebruikt automatisch de rechten die aan jouw API-profiel zijn gekoppeld.
Voor websites en scripts
Geschikt voor eigen scripts, dashboards, websites en systemen die JSON kunnen verwerken.
Voor XML-systemen
Geschikt voor systemen die vaste XML-structuren verwachten.
Voor feedlezers
Geschikt voor standaard RSS-readers en eenvoudige monitoringtools.
Voorbeeld vaste JSON-feed:
https://www.alarmcheck.nl/p2000-api/json/jouw-json-token
Geavanceerde JSON API met filters
De geavanceerde JSON API gebruik je als je zelf wilt bepalen welke meldingen je op dat moment ophaalt. Je gebruikt dezelfde persoonlijke toegang, maar voegt extra queryfilters toe.
https://www.alarmcheck.nl/api/v1/meldingen?token=jouw-json-token&limit=25
Beschikbare queryfilters
| Filter | Voorbeeld | Uitleg |
|---|---|---|
| limit | &limit=5 |
Beperkt het aantal resultaten. De maximale limiet hangt af van je API-profiel. |
| regio | ®io=Gelderland-Zuid |
Haalt alleen meldingen op uit de gekozen regio, mits je daar rechten voor hebt. |
| plaats | &plaats=Tiel |
Filtert op de opgeschoonde plaatsnaam van de melding. |
| prio | &prio=A1 |
Filtert op prioriteit, bijvoorbeeld A1, A2, B1, B2, P1 of P2. |
| categorie | &categorie=Ambulance |
Filtert op hulpdienst of categorie, zoals Brandweer, Ambulance of Politie. |
| q | &q=aanrijding |
Zoekt in de meldingstekst. Dit filter is bedoeld voor woorden zoals aanrijding, brand, ongeval of straatnamen. |
| capcodes | &capcodes=0923100 |
Filtert op capcodenummer. Capcode-omschrijvingen tellen niet mee als filtercriterium. |
Voorbeelden van API-aanroepen
Laatste 5 meldingen
/api/v1/meldingen?token=jouw-token&limit=5
Alleen Tiel
/api/v1/meldingen?token=jouw-token&plaats=Tiel
Alleen A1
/api/v1/meldingen?token=jouw-token&prio=A1
Zoeken op aanrijding
/api/v1/meldingen?token=jouw-token&q=aanrijding
Velden in de JSON-output
| Veld | Betekenis |
|---|---|
| ok | Geeft aan of de API-aanroep succesvol is verwerkt. |
| generated_at | Datum en tijd waarop de API-output is aangemaakt. |
| filters | Laat zien welke filters bij de aanvraag zijn gebruikt. |
| count | Aantal meldingen in het resultaat. |
| items | Lijst met meldingen. |
| message | De oorspronkelijke meldingstekst, opgeschoond waar nodig. |
| category | Hulpdienst of categorie, bijvoorbeeld Brandweer, Ambulance of Politie. |
| priority | Prioriteit, bijvoorbeeld A1, A2, P1 of P2. Niet iedere melding heeft een prioriteit. |
| region | Regio waaronder de melding valt binnen de API-rechten. |
| place | Opgeschoonde plaatsnaam. |
| location | Locatieveld voor weergave of geocoding. Kan leeg zijn als er geen betrouwbare locatie beschikbaar is. |
| capcodes | Gealarmeerde capcodes met omschrijving. |
| public_url | Openbare link naar de melding op Alarmcheck. |
Exportportaal
Als exportrechten zijn toegekend, krijg je één exportportaal-link. Op die pagina kies je zelf het gewenste bestandstype en de filters die binnen jouw rechten vallen.
Formaat kiezen
Kies CSV, Excel of PDF. Je ziet alleen de formaten die voor jouw account zijn vrijgegeven.
Regio’s kiezen
Kies één of meerdere toegewezen regio’s. Niets kiezen betekent: alle toegewezen regio’s.
Periode kiezen
Kies een periode binnen de maximale exportperiode die door de beheerder is ingesteld.
Exportfilters
In het exportportaal kun je, afhankelijk van je rechten, extra filters gebruiken om de export kleiner en gerichter te maken.
Meerdere regio’s
Selecteer één of meerdere regio’s waarvoor je rechten hebt.
Brandweer, Ambulance of Politie
Beperk de export tot één hulpdienst of laat deze op alle hulpdiensten staan.
Bijvoorbeeld Tiel
Gebruik dit om alleen meldingen van een bepaalde plaats op te halen.
Bijvoorbeeld A1 of P1
Gebruik dit als je alleen meldingen met een bepaalde prioriteit wilt exporteren.
API-profielen en limieten
Het API-profiel bepaalt hoe zwaar de koppeling gebruikt mag worden. De beheerder kan per klant afwijkende rechten instellen.
Starter
Voor lichte koppelingen, lage aantallen en eenvoudige feedlinks.
Pro
Voor vaker gebruik, meer resultaten en uitgebreidere filters.
Business / maatwerk
Voor zakelijke koppelingen, grotere exports of specifieke afspraken.
Goed gebruik
- Gebruik de vaste feedlinks voor simpele automatische koppelingen.
- Gebruik de geavanceerde JSON API als je zelf filters wilt meegeven.
- Gebruik een passende limiet, bijvoorbeeld 25 of 50 meldingen.
- Bewaar tokens veilig en deel ze niet openbaar.
- Gebruik het exportportaal voor handmatige downloads.
Belangrijk om te weten
- Niet iedere P2000-melding bevat een duidelijke plaats of locatie.
- Een lege plaats of locatie betekent niet automatisch dat de melding fout is.
- MMT- en landelijke meldingen kunnen via capcodes binnen je rechten vallen.
- Te brede zoekwoorden kunnen veel resultaten geven.
- Gebruik geen onnodig hoge requestfrequentie.
Veelvoorkomende vragen
Waarom zie ik XML zonder opmaak?
Dat is normaal. Browsers tonen XML en RSS vaak als ruwe documentstructuur. Dat betekent niet dat de feed fout is.
Waarom krijg ik minder resultaten dan verwacht?
De API blijft altijd binnen je rechten, limieten, filters en ingestelde periode.
Waarom is een locatie soms leeg?
Als er geen betrouwbare plaats of locatie uit de melding gehaald kan worden, blijft het locatieveld leeg.
Kan ik mijn links opnieuw ontvangen?
Ja. Vraag de beheerder om de API- en exportlinks opnieuw naar je te mailen.
Storing of foutmelding?
Controleer eerst of je token klopt, of je rechten nog actief zijn en of je niet buiten je toegestane regio’s of limieten zoekt. Blijft het probleem bestaan, stuur dan de gebruikte URL, het gewenste resultaat en de foutmelding door naar de beheerder.