Integraties en API

Met een API-sleutel koppel je je praktijkmanagementsysteem aan The Dutch Dataroom; met webhooks krijg je bericht wanneer er iets gebeurt. Beide staan onder Kantoorbeheer → Integraties.

Een API-sleutel maken

1. Open Kantoorbeheer → Integraties.
2. Kies Sleutel maken.
3. Geef de sleutel een herkenbare naam (bijvoorbeeld koppeling praktijksysteem).
4. Kies de scopes: welke onderdelen mag deze sleutel lezen of schrijven?
5. Stel de geldigheid in dagen in.
6. Kopieer de sleutel meteen: je ziet hem één keer.

De sleutel werkt daarna zonder verdere inlogstap. Bewaar hem in de configuratie van je systeem, niet in een document of chat.

Scopes en rechten

Een sleutel krijgt nooit meer rechten dan de scopes die je kiest. Kies de kleinste set die werkt:

Scope	Wat het toestaat
Datarooms lezen	De lijst met datarooms en hun inrichting lezen
Datarooms beheren	Datarooms aanmaken en wijzigen
Documenten lezen	De index en documentgegevens lezen
Documenten uploaden	Bestanden toevoegen
Documenten downloaden	Originelen ophalen waar dat is toegestaan

Intrekken en verlopen

Een sleutel verloopt op de ingestelde datum. Je kunt hem ook per direct intrekken. Trek een sleutel in als een koppeling stopt of als je vermoedt dat hij is uitgelekt; maak daarna een nieuwe aan.

Webhooks

Een webhook stuurt een bericht naar jouw systeem bij een gebeurtenis: een upload, een nieuw verzoek, een ondertekend document. Elke oproep is ondertekend met een gedeelte dat je met het geheim van het endpoint kunt narekenen, zodat je systeem zeker weet dat het bericht van ons komt. Je ziet per endpoint welke gebeurtenissen zijn afgeleverd en welke zijn mislukt.

Mislukt een aflevering, dan blijft die zichtbaar met de status. Zo zie je meteen of je systeem iets heeft gemist; je hoeft niet in je eigen logs te zoeken.

API-documentatie

De technische documentatie staat openbaar op /api-docs, met de scopes, de ondertekening van webhooks en de MCP-koppeling voor AI-assistenten. Het OpenAPI-document zelf staat op /api-docs/openapi.json en is altijd gelijk aan de versie die wordt aangeboden.

De API-documentatie op /api-docs: scopes, webhook-ondertekening en de MCP-koppeling.

Eén sleutel per koppeling

Gebruik een aparte sleutel per systeem. Dan kun je één koppeling intrekken zonder de rest te raken, en zie je in het overzicht welke sleutel waarvoor dient.