
API
API-integratie voor partners
Technische documentatie voor het koppelen van uw eigen software via de REST API.
Wat de DuurzaamAdvies-API doet
Met de DuurzaamAdvies-API koppelt u onze rekenmotor en advieslogica direct aan uw eigen software — een CRM, een offerte-tool of een klantportaal. Elke partner krijgt een eigen sandbox plus productieomgeving, met identieke endpoints en datacontracten.
Wat u kunt automatiseren
- Adviesrapport aanvragen — POST een adres of woninggegevens en ontvang een volledig adviesrapport in JSON (en optioneel PDF).
- Energielabel ophalen — koppel automatisch het officiële energielabel uit EP-online aan uw woningdossier.
- Maatregelpakketten samenstellen — kies uit het volledige assortiment verduurzamingsmaatregelen en bereken kosten, terugverdientijd en subsidies.
- Webhook-notificaties — ontvang een callback zodra een rapport is gegenereerd of een betaling is voltooid.
Basisflow voor een eerste integratie
- Maak in uw partnerportaal een API-sleutel aan (zie Authenticatie en API-sleutels).
- Test alle endpoints in de sandbox — sandbox-credits zijn gratis en verbruiken geen quotum.
- Vraag in de sandbox een proefrapport aan via
POST /api/advice-reportsmet een test-adres. - Verwerk het JSON-resultaat in uw eigen UI en laat een gebruiker het rapport bekijken.
- Vraag activatie van uw productiesleutel aan zodra de integratie acceptatie-getest is.
Datacontract en stabiliteit
Alle endpoints retourneren camelCase-JSON. Breaking changes worden minimaal 30 dagen vooraf aangekondigd via e-mail en de API-changelog op /api/changelog. Niet-breaking velden kunnen zonder kennisgeving worden toegevoegd — bouw uw deserializer dus tolerant.
Volgende stappen
- Authenticatie en API-sleutels — uitleg over hoofd- en sub-sleutels.
- Rate limiting en API-quota's — limieten per sleutel.
- Webhooks instellen — asynchrone notificaties verwerken.
- API-foutcodes en troubleshooting — HTTP-statuscodes uitgelegd.