...
Download de OpenAPI-specificaties.
...
Over deze documentatie
In deze documentatie vindt u aan welke API-specificaties uw bron moet voldoen om attesten en vergunningen beschikbaar te maken in Mijn Burgerprofiel.
...
Het is relatief eenvoudig om nieuwe bronnen voor attesten en vergunningen toe te voegen op Mijn Burgerprofiel. Aansluitende partijen/partners die voldoen aan de deze API-specificaties kunnen na een korte configuratie hun attesten en vergunningen beschikbaar maken in Mijn Burgerprofiel.
JSON
We standardize on gebruiken application/hal+json. This specific form of JSON flags that the payload is HATEOAS compliant als standaard. Deze specifieke JSON geeft aan dat de payload voldoet aan de HATEOAS-standaard.
Layout
URL's
...
We advise you to follow our example, and put a version in the URL. Debates are going on strongly about whether or not to use a v1 in your URL, but it is a pragmatic choice we implement in our API's. The version parameter is always a natural number, ie v1, v2, ... Within a certain version, breaking changes can never occur. If you introduce breaking changes, the next version should be released.
...
en versiebeheer
We raden u aan om ons voorbeeld te volgen en een versienummer toe te voegen aan de URL. Het versienummer is altijd een cijfer, bijv. v1, v2, … Er kunnen nooit breaking changes bestaan binnen een bepaalde versie. Zijn er toch breaking changes nodig, zorg dan voor een nieuwe versie.
Een URL voor uw endpoint kan er als volgt uitzien: https://<hostname>/v1/certificates/<ssn>?limit=10&page=0
Required fields
We have carefully documented which fields are optional, and which are not. Please refer to the OpenAPI documentation of the API for more information.
...
Verplichte velden
In de de OpenAPI-specificaties vindt u een overzicht van de verplichte en de optionele velden. Indien nodig kunt u extra velden toevoegen.
| Note |
|---|
Digitaal Vlaanderen vertaalt alleen de velden in de OpenAPI-specificaties. |
Certificates listing
This is the most important endpoint you need to provide. It needs to return a list of certificates which are relevant for the user. The user can be identified via his/her social security number (ssn) (= INSZ/NISS). The list is essentially a list of Certificate Detail items. Refer to the OpenAPI documentation of the API for more information.
...