# Introductie Met deze API is het mogelijk om volledig geautomatiseerd brondocumenten aan te leveren aan het Bronhouderportaal BRO. De API is RESTful opgezet. In vogelvlucht werkt de API door eerst een Upload aan te maken waar vervolgens, door middel van het sturen van een POST request met als body de XML van het brondocument, meerdere Brondocumenten aan kunnen worden toegevoegd. Van de Upload kan een Levering gemaakt worden. Vervolgens kan de status van de levering periodiek worden opgevraagd, waarbij uiteindelijk een BRO-ID teruggeven wordt. Ter ondersteuning van de kwaliteitscontrole van een levering is het mogelijk om een levering en/of de brondocumenten van een levering te verrijken met extra gegevens. Daarnaast kunnen brondocumenten gevalideerd worden, zonder dat hiervoor een levering wordt aangemaakt. Deze functionaliteit is tevens geschikt om te testen of de koppeling met de API correct functioneert. # Authenticatie Om van de API gebruik te kunnen maken, dient een aanlevertoken te worden aangemaakt in het Bronhouderportaal. Dit aanlevertoken bestaat uit twee delen: een token username en het daadwerkelijke token (password) zelf. Het password is in een later stadium niet meer op te vragen en is ook niet bekend binnen het Bronhouderportaal BRO. Het password kan later eventueel wel worden gereset. De API gebruikt _HTTP basic authentication_. Dit betekent dat bij elk request een __Authorization__ header meegestuurd moet worden bestaande uit de Base64 encoding van de string `USERNAME:PASSWORD` waarbij:

USERNAME: de token username (e.g. 0dce6fc98256|123456789|1234)
PASSWORD: het eenmalig gegenereerde token (e.g. cf573933d8be536a8ad18edfe4f69bd010f944a686abf1f6b13c5d2a455cdc32)

Succesvol kunnen authenticeren kan getest worden door een validatie verzoek te sturen via het validatie endpoint van API. Dit endpoint valideert brondocumenten zonder de betreffende omgeving te vervuilen met testleveringen.

Bronhouderportaal BRO API (1.0.0) - API specificatie

Binnenlandse Zaken en Koninkrijksrelaties

API documentatie

Praat mee in onze developer community