API overzicht
Functioneel overzicht van de belangrijkste API groepen binnen FunderConsult.
2 min lezen
FunderConsult heeft meerdere API-domeinen, elk met een eigen verantwoordelijkheid. Door die domeinen goed te scheiden, blijven integraties overzichtelijk en onderhoudbaar.
Belangrijkste API groepen
| Domein | Routepatroon | Gebruik |
|---|---|---|
| QuickScan-app | /api/quickscan-app/... |
Projecten, metingen, rapportage |
| Kennisbank | /api/kennisbank/..., /api/admin/articles en /api/admin/article-chapters |
Artikelen, structuur, contentbeheer; /api/admin/kennisbank/... alleen nog voor JSON-archief en AI-hulp |
| Incidenten | /api/incidents/... |
Meldingen, workflow, analytics |
| Feedback | /api/feedback/... |
Inzendingen en configuratie |
| Herstelregistratie | /api/herstelregistratie/... |
Dossiers, bestanden, certificaten |
| Admin algemeen | /api/admin/... |
Platforminrichting en beheer |
Integratie-aanpak
- Werk met stabiele identifiers.
- Controleer rechten per endpoint.
- Log mutaties en imports.
- Gebruik eenduidige foutafhandeling.
In het FunderPortal
Heeft je organisatie toegang tot de FunderConsult API, dan open je in het FunderPortal de pagina FunderConsult API. Daar vraag je risico-indicatoren op per BAG-ID of in batches. In de nieuwe weergave is de pagina verdeeld over de tabbladen Overzicht, Toegang, Testen, Laatste calls en Documentatie; in de oude weergave staat alles onder elkaar.
- API-sleutel: je maakt hem niet zelf aan; de pagina maakt hem voor je organisatie aan. Je vindt hem onder Huidige API key en zet hem in de header
x-api-key. Met API key roteren maak je een nieuwe sleutel; de oude werkt daarna niet meer. - Limieten: er geldt een limiet per minuut, per dag en per batch (het aantal BAG-ID's per call). Ze zijn per organisatie ingesteld en staan op Toegang onder Limieten. Op Overzicht zie je het gebruik van deze minuut en van vandaag (UTC). Boven de limiet geeft de API HTTP 429, met
minute_limit_reachedofdaily_limit_reached. - Testen: zoek op Testen een adres of vul een BAG-id in en klik op Test uitvoeren. Je ziet het antwoord leesbaar en als ruwe JSON. Een test is een echte call: hij telt mee voor je limiet en staat daarna bij Laatste calls. Onder Voorbeeldcode staat code voor een single en een batch lookup.