Ketenafspraken: feedback, correctie, chunking, transport, releases
Transport en beveiliging: REST, x-api-key, OAuth 2.0, mTLS en x-jws-signature
VB-PUO gebruikt uitsluitend RESTful API's over HTTPS in een push-model: de verzender neemt het initiatief. Authenticatie verloopt met een API-sleutel in de x-api-key-header of met OAuth 2.0 client credentials; tweezijdige TLS (mTLS) is het uitgangspunt en berichten kunnen digitaal worden ondertekend met de x-jws-signature-header.
Stappen
- InrichtingBeide partijenWissel endpoints, API-sleutels of OAuth-clients en certificaten uit; leg de OAS-versie vast (1.0.11 bij Release 2027).
- VerzendenVerzenderPOST van het JSON-bericht met x-api-key (of bearer token) en optioneel x-jws-signature.
- OntvangenOntvangerVerifieer handtekening, valideer tegen het schema van de opgegeven afdDefinitionVersion en antwoord volgens de zes feedbackpatronen.feedback
Regels en verbandscontroles
- Andere transportvormen (bestanden, e-mail) worden door de standaard niet ondersteund.
- GitHub-issues #102 en #143 gaan over mTLS-inrichting; #106 over API-versionering.
Bron: Handleiding paragraaf 2.7 en 7.4