Ontwikkelaars en API
De publieke API gebruiken
Maak een project, bescherm de sleutel, vraag gegevens op en verwerk paginering en fouten.
Maak een project voor je koppeling
Log in en open de ontwikkelaarsinstellingen. Geef het project een herkenbare naam, een concrete gebruiksomschrijving van minimaal 20 tekens en eventueel de publieke HTTPS-URL van je platform. Accepteer de huidige API-voorwaarden voordat je de sleutel maakt.
Elk project heeft één actieve sleutel; geef verschillende koppelingen hun eigen project. De huidige limiet is drie niet-gearchiveerde projecten per account. Een bevestigd e-mailadres is voor API-projecten niet verplicht.
Het eerste verzoek uitvoeren
Kopieer de volledige sleutel zodra hij wordt getoond: later kun je hem niet terughalen. Bewaar hem in een server-side omgevingsvariabele of geheimenbeheerder, nooit in browsercode. Alleen endpoints onder /api/v1 vormen het publieke contract.
Voer dit uit op je eigen backend of in een terminal. Vervang de voorbeelddomeinnaam door de Dashpatch-origin die je gebruikt en laad DASHPATCH_API_KEY veilig in je omgeving. Het voorbeeld leest alleen gegevens.
curl "https://dashpatch.example/api/v1/incidents?status=active&per_page=5" \
-H "Authorization: Bearer $DASHPATCH_API_KEY" \
-H "Accept: application/json"Kies de juiste gegevensbron
Gebruik incidents voor gegroepeerde context en messages voor afzonderlijke P2000-berichten. Gemeente- en woonplaats-URL’s gebruiken slugs, capcode-URL’s de publieke code inclusief voorloopnullen en matrixborddetails de gedocumenteerde UUID.
Geneste endpoints zoals /api/v1/localities/{slug}/messages en /api/v1/capcodes/{capcode}/messages geven een bijbehorende berichtenstroom. Controleer de referentie voor filters, rechten en identifiers; website-URL’s zijn niet automatisch API-endpoints.
Paginering, limieten en fouten
Lijsten bevatten standaard 25 items en maximaal 100. Volg links.next totdat deze null is; verzin geen cursors. De standaardlimiet is 60 verzoeken per minuut per project, maar een beheerder kan een andere limiet instellen. Cache bruikbare resultaten en wacht bij HTTP 429 in plaats van parallel opnieuw te proberen.
401 betekent een ontbrekende of ongeldige sleutel; 403 kan wijzen op project- of accountstatus, voorwaarden of scopes; 404 betekent niet gevonden; 422 betekent ongeldige parameters. Lees error.code, error.detail en eventuele veldfouten. Herhaal tijdelijke fouten met begrensde wachttijden, niet in een eindeloze lus.
Sleutels vervangen en live testen
Een nieuwe sleutel trekt de vorige onmiddellijk in. Werk clients direct bij; er is geen overlappende overgangsperiode. Een project archiveren trekt de sleutel ook in.
De live tester in de referentie werkt alleen op de geconfigureerde Dashpatch-origin en verstuurt same-origin-verzoeken. De sleutel blijft in paginageheugen, niet in blijvende browseropslag. Deze beperking geldt niet voor normale geauthenticeerde server-naar-server-verzoeken. Wis het veld of verlaat de pagina na gebruik en deel geen screenshots met sleutels.