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.
Waarom API-specificaties
Het is relatief eenvoudig om nieuwe bronnen voor attesten en vergunningen toe te voegen op Mijn Burgerprofiel. Aansluitende partijen/partners die voldoen aan deze API-specificaties kunnen na een korte configuratie hun attesten en vergunningen beschikbaar maken in Mijn Burgerprofiel.
OpenAPI-specificaties
Download de OpenAPI-specificaties.
JSON
We gebruiken application/hal+json als standaard. Deze specifieke JSON geeft aan dat de payload voldoet aan de HATEOAS-standaard.
Layout
URL's 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
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.
Digitaal Vlaanderen vertaalt alleen de velden in de OpenAPI-specificaties.
Lijst met attesten
Dit is het belangrijkste endpoint dat u moet voorzien. Dit endpoint moet zorgen voor een lijst met attesten en vergunningen die bij de aangemelde gebruiker horen, inclusief de details over die attesten en vergunningen. De gebruiker wordt geïdentificeerd op basis van zijn/haar INSZ-nummer.
Zie ook de OpenAPI-specificaties voor meer informatie.
Er moeten links worden voorzien zodat de client door de verschillende pagina’s met attesten en vergunningen kan navigeren. Zie ook HATEOAS voor meer informatie en voorbeelden.
De response moet altijd een paginering hebben. De metadata bij de pagina’s moet deel uitmaken van de payload zodat de client weet hoeveel attesten en vergunningen er zijn, op welke pagina’s die staan, enz. Zie ook de voorbeelden hieronder.
The URL heeft een
page-parameter, die 0-based moet zijn. Zodra 0 is gepasseerd, moet de eerste pagina worden meegegeven.In de metadata van de pagina is er echter niets 0-based, alleen 1-based. Bijv. de
number-parameter moet op de eerste pagina de waarde 1 hebben.
Model-specifieke informatie
certificates (verplicht): lijst met attesten, eigenlijk een lijst met detailinformatie over de attesten en vergunningen (zie hieronder).
Worden er geen attesten of vergunningen gevonden voor het INSZ-nummer, dan moet de lijst leeg zijn.
Request (voorbeeld)
Headers: Authorization: Bearer XyZAbCd1234
Method: GET
URL https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0
Response (voorbeeld)
{
"certificates": [
{
"id": "85144567-7043-4469-9e79-279f4eb31e27",
"language" : "nl",
"name": "Dienstencheques 2019",
"year": 2019,
"links": [
{
"rel": "self",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl"
},
{
"rel": "download",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download"
}
]
}
],
"pageMetadata": {
"number": 1,
"size": 10,
"totalElements": 40,
"totalPages": 4
},
"links": [
{
"rel": "self",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0"
},
{
"rel": "next",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=1"
},
{
"rel": "start",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0"
},
{
"rel": "last",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=3"
}
]
}
Paginering en maximumwaarden
Paginering verplicht
De response moet gepagineerd zijn voor elke collection die wordt meegegeven. De volgende 2 parameters in de URL’s moeten hiervoor aanwezig zijn: I
page: het paginanummers (0-based)limit: het aantal items op 1 pagina (1-based)
Gepagineerde resultaten zijn natuurlijk alleen nodig wanneer er een collectie als resultaat is. Voor 1 attest/vergunning + details is er een paginering nodig.
Worden er geen attesten of vergunningen gevonden voor het INSZ-nummer, dan moet de lijst leeg zijn.
De API-client kan de maximumwaarde kiezen
De parameters voor de paginering en de maximumwaarden maken deel uit van de URL: https://<hostname>/v1/certificates/<ssn>?limit=10&page=0. T
De API-client kan de parameter met de grenswaarde controleren. Als de client 10 items vraagt, dan moeten er 10 worden gegeven. Vraagt de client er 50, dan moeten er 50 worden gegeven.
Er kan natuurlijk een maximumwaarde worden bepaald. Werk met een maximumwaarde van 100 items. Vraagt de client om meer resultaten dan die in de maximumwaarde, dan wordt de default maximumwaarde getoond.
Er werden geen default-waarden gedefinieerd
Bij gebrek aan defaults voor de paginering (page) en maximumwaarde (limit) moet de API terugvallen op redelijk defaults.
De onderstaande requests zijn dus perfect bruikbaar:
https://<hostname>/v1/certificates/<ssn>?limit=10&page=0https://<hostname>/v1/certificates/<ssn>?limit=10https://<hostname>/v1/certificates/<ssn>?page=0
Worden er geen defaultwaarden gedefinieerd, gebruik dan deze logische defaults:
page: de eerste paginalimit: 10
Metadata voor paginering
Metadata voor paginering zijn verplicht in het pageMetadata-object in de response:
"pageMetadata": {
"number": 1,
"size": 10,
"totalElements": 40,
"totalPages": 4
}
De volgende 4 parameters zijn verplicht (allemaal 1-based)
numberhet paginanummersizehet paginanummer in het totaal aantal pagina’stotalElementshet totale aantal items in de collectietotalPageshet totale aantal pagina’s in de collectie
Er werden geen attesten of vergunningen gevonden
Wanneer er voor een bepaald INSZ-nummer geen attesten of vergunningen worden gevonden, verwachten we een lege collectie als antwoord, geen error 404.
Zie ook de Foutberichten.
Detail attest/vergunning
Dit is de link waarachter meer details over een attest/vergunning beschikbaar zijn. Deze link zorgt ervoor dat de klant bepaalde functionaliteiten kan vinden, zoals bijv. het attest/de vergunning downloaden.
Zie ook HATEOS.
Er kunnen extra velden worden toegevoegd in de response, maar ze zullen niet meegenomen worden.
Primary key
Dit zijn de parameters die het attest/de vergunning definiëren. Voor een attest is de primary key: ID + taal. Beide moeten dus in de URL staan. Afhankelijk van de opzet zijn dit path parameters of query parameters.
In de voorbeelden zijn het path parameters. Omdat we een HATEOAS design verwachten, vinden we de URL via uw API.
Model-specifieke informatie
id (verplicht): het ID van het attest/de vergunning
taal (verplicht): de taal van het attest/de vergunning, verplicht in ISO639-1 formaat:
nl,fr,de,en. Zie ook: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes .naam (verplicht): de naam van het attest/de vergunning
jaar (optioneel): het jaar dat het attest/de vergunning werd uitgegeven (indien van toepassing)
community (optioneel): de gemeente waar het attest/de vergunning werd uitgegeven (indien van toepassing). Dit moet een NIS-code zijn. Zie ook: https://statbel.fgov.be/nl/over-statbel/methodologie/classificaties/geografie
Request (voorbeeld)
Headers:
Authorization: Bearer XyZAbCd1234Method: GET
URL
https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl
Response (voorbeeld)
{
"id": "85144567-7043-4469-9e79-279f4eb31e27",
"language" : "nl",
"name": "certificate-1234",
"links": [
{
"rel": "self",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl"
},
{
"rel": "download",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download"
}
]
}
HATEOAS
Over HATEOAS
Als de specificaties worden gevolgd, zijn alle API’s conform HATEOAS (Hypermedia As The Engine Of Application State). Waarom is dit zo belangrijk? Deze architecturale component zorgt ervoor dat een REST-client de API volledig ontdekt, zonder voorafgaande kennis. Alleen het entrypoint van de API is hiervoor nodig. Van daar kan de client door de API ‘crawlen’ door relaties (rels) en referenties (hrefs) te gebruiken.
Bij Digitaal Vlaanderen kunnen we dankzij HATEOAS uw API volledig ontdekken zonder een client te schrijven met specifieke kennis over uw API.
Hoe implementeren?
Volg de onderstaande voorbeelden. Voeg HATEOAS toe aan uw uw API door de links-sectie toe te voegen. De links-sectie moet beschikbaar zijn voor de lijst met attesten/vergunningen en bij de details van een specifiek attest/vergunning.
Links - Lijst attesten/vergunningen
Een links-sectie voor een lijst attesten/vergunningen ziet er gewoonlijk als volgt uit:
"links": [
{
"rel": "self",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0"
},
{
"rel": "next",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=1"
}
{
"rel": "start",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=0"
},
{
"rel": "last",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302?limit=10&page=1"
}
]
De volgende 4 verschillende relaties moeten aanwezig zijn
self(verplicht) de href-verwijzingen naar de huidige paginanext(verplicht op voorwaarde dat er meerdere pagina’s zijn) de href-verwijzingen naar de volgende pagina in de gepagineerde collectie. Moet er alleen zijn als er effectief een volgende pagina is om naar te verwijzenstart(verplicht) de href-verwijzing naar de eerste pagina van de collectie to the start page of the collection.last(verplicht) de href-verwijzing naar de laatste pagina van de collectie
Links - Certificate Detail
Een links-sectie voor de detailinformatie bij de attesten/vergunningen ziet er gewoonlijk als volgt uit:
"links": [
{
"rel": "self",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl"
},
{
"rel": "download",
"href": "https://burgerprofiel.vlaanderen.be/v1/certificates/90061638302/85144567-7043-4469-9e79-279f4eb31e27/nl/download"
}
]
De volgende 2 verschillende relaties moeten aanwezig zijn
self(verplicht) de href-verwijzing naar de detailinformatie bij het attest/vergunningdownload(verplicht) de href-verwijzing naar de downloadlink bij het attest/vergunning. Dit moet een directe link zijn, die gestreamd kan worden naar de gebruiker.