Document toolboxDocument toolbox

Release notes - Publieke API

Deze pagina geeft per release weer welke wijzigingen doorgevoerd worden met impact op de publieke API.

Bij elke release vind je 2 data terug: wanneer deze versie beschikbaar komt op de staging omgeving en wanneer deze beschikbaar staat op de productie omgeving.

  • Voor wijzigingen die geen impact hebben op bestaande implementaties (non-breaking changes zoals extra functionaliteiten, extra velden, …) wordt de release op productie 1 week na de release op staging uitgevoerd.

  • Voor wijzigingen met impact op bestaande implementaties (breaking changes) worden de release data zowel op staging als op productie ruim op voorhand aangekondigd.

De versie nummering wordt gelijk gehouden voor alle ontwikkelingen van het verenigingsregister. Soms gebeurt het dus dat een nieuwe versie in productie gezet wordt die geen impact heeft op de publieke API. In dat geval gaan we die versie gewoon vermelden, al was het maar om de versie nummers te kunnen controleren.

Het huidige versie nummer van de publieke API vind je terug in de API documentatie. Helemaal onderaan wordt het versie nummer dat nu op die omgeving staat weer gegeven.

 

Status van de diensten: zie https://www.vlaanderen.be/digitaal-vlaanderen/status/status-overzicht?product=Verenigingsregister

Versie 8.163.0 werkingsgebied

Datum staging: Oct 16, 2024

Datum productie: Oct 23, 2024

Werkingsgebied

Een nieuw concept werkingsgebied werd toegevoegd. Dit is een lijst van codes (NUTS&LAU) die aan een vereniging kan toegevoegd worden en die aangeeft welke regio's (gemeente, provincie, …) deze vereniging haar werkingsgebied is.

De huidige werkingsgebieden van een verenigingen kan je terugvinden zowel in publiek detail als via de zoek functie, telkens met zowel de code als de naam. Voorbeeld:

"werkingsgebieden": [ { "@id": "wg:df28db28-1005-5a2f-a892-4495b2f45852", "@type": "skos:Concept", "code": "BE1", "naam": "Brussels Gewest" }, { "@id": "wg:66ea53ba-95fd-567f-8610-4761e88a6e8c", "@type": "skos:Concept", "code": "BE21", "naam": "Provincie Antwerpen" } ]

In de zoekfunctie kan je de code van het werkingsgebied gebruiken als zoekcriterium. enkele voorbeelden:

/v1/verenigingen/zoeken?q=werkingsgebieden.code:BE25 /v1/verenigingen/zoeken?q=werkingsgebieden.code:(BE21 OR BE25)

Versie 8.154.1 Bugfixes

Datum staging: Oct 3, 2024

Datum productie: Oct 9, 2024

Bugfixes

Er werd een bug gefixt

  • publieke zoek: wanneer er meer dan 20 facets in de zoekresultaten zitten, worden er toch maar 20 facets getoond

Versie 8.148.0 Export publieke informatie voor externe toepassingen

Datum staging: Sep 18, 2024

Datum productie: Oct 9, 2024

Export publieke informatie voor externe toepassingen

Er is een nieuw endpoint toegevoegd op de publieke API, waarmee externe partijen met specifieke toelating het recht hebben om alle publieke informatie van alle verenigingen op te vragen met 1 streaming endpoint.

Versie 8.146.0 Minimum dataset - Vermijden dat de laatste locatie, vertegenwoordiger of hoofdactiviteit verwijderd wordt

Datum staging: Sep 11, 2024

Datum productie: Oct 9, 2024

Minimum dataset

Het zal nog steeds mogelijk zijn om vereniging te registreren zonder locatie, vertegenwoordiger of hoofdactiviteit. Maar van zodra een vereniging een van deze elementen bevat, dan zal het niet meer mogelijk zijn om de laatste van zijn soort te verwijderen:

  • Wanneer een vereniging al een locatie heeft, dan kan de laatste locatie niet meer verwijderd worden

  • Wanneer een vereniging al een vertegenwoordiger heeft, dan kan de laatste vertegenwoordiger niet meer verwijderd worden

  • Wanneer een vereniging al een hoofdactiviteit heeft, dan kan de set van hoofdactiviteiten niet meer leeg gemaakt worden

Versie 8.133.5.6 Mutatie dienst + initiële adresmatch

Datum staging: Aug 14, 2024

Datum productie: Aug 28, 2024

Algemeen: initiële adresmatch

We hebben een proces toegevoegd dat alle adressen overloopt in het register. Elke adres dat nog niet is geverifieerd ten opzichte van het adressenregister, wordt opgezocht via adresmatch. Wanneer een resultaat wordt gevonden, wordt het adresId toegevoegd en worden de adrescomponenten aangepast aan de spelling zoals deze in het adressenregister voorkomt.

Publieke API: Mutatie dienst

In de publieke API is een nieuw endpoint beschikbaar dat kan gebruikt worden voor afnemers die synchroniseren naar hun eigen databank/CRM. Met dit endpoint kan je alle vCodes opvragen waarvoor er een wijziging is gebeurd sinds de laatste keer dat je de synchronisatie hebt uitgevoerd.

Om dit endpoint aan te spreken heb je een API Key nodig.

Voorbeeld:

GET <publiekURL>/v1/verenigingen/mutaties?sinds=<vorigeMaxSequence> response body: [ { "vCode": "V0001027", "sequence": 86 }, { "vCode": "V0001024", "sequence": 89 } ]

In dit voorbeeld weet je nu dat V0001027 en V0001024 gewijzigd zijn. Om die te synchroniseren, haal je data op via een of meerdere van volgende (bestaande) endpoints:

  • Beheer Detail: <BeheerURLviaMAGDA>/v1/verenigingen/<vCode>

    • om alle gegevens van een vereniging op te vragen

  • Publiek Detail: <PubliekURL>/v1/verenigingen/<vCode>

    • om alle publieke gegevens van een vereniging op te vragen - dit gebruik je wanneer jouw organisatie enkel met publieke gegevens werkt OF wanneer je geen recht hebt om alle gegevens via MAGDA op te vragen

  • Beheer Historiek: <BeheerURLviaMAGDA>/v1/verenigingen/<vCode>/historiek

    • om meer informatie te bekomen over de wijzigingen die zijn uitgevoerd (enkel wanneer je hier toegang toe hebt)

Na synchronisatie, onthou je de hoogste verwerkte sequence (in het voorbeeld is dat 89) zodat je de volgende keer alle nieuwe wijzigingen kan opvragen via

Goed om weten: in dit endpoint komen ALLE vCodes voor en worden ALLE wijzigingen gereflecteerd. Dit heeft enkele gevolgen die je best mee overweegt bij de implementatie van deze mutatiedienst. Enkele voorbeelden:

  • Wanneer er iets veranderd aan een vertegenwoordiger van een vereniging, dan is dit een wijziging, maar via de publieke data stroom zal je geen enkel verschil opmerken.

  • Wanneer een vereniging uitgeschreven wordt uit de publieke datastroom, dan komt dit naar voor als wijziging, maar via de publieke datastroom betekent dit dat je de vereniging plots niet meer zal terugvinden. (Publiek detail geeft dan een 404)

  • Wanneer een vereniging verwijderd wordt, dan komt dit naar voor als wijziging, maar noch bij publiek, noch bij beheer detail zal je deze vereniging nog terugvinden (respons = 404). Via beheer historiek kan je wel nog terugvinden dat deze vereniging verwijderd is, met daarbij de reden van verwijdering.

Versie 8.121.0 Dagelijkse synchronisatie met het adressenregister

Datum staging: Jul 24, 2024

Datum productie: Aug 28, 2024

Versie 8.118.0 synchronisatie met adressenregister + bugfix voor lege locatie naam

Datum staging: Jul 18, 2024

Datum productie: Aug 28, 2024

Versie 8.92.1 Adresmatch op ingevoerde adressen + statuspagina

Datum staging: Apr 30, 2024

Datum productie: May 15, 2024 (verwacht - uitgesteld) - Aug 28, 2024 uitgevoerd

Versie 8.85.8 Bugfix voor de synchronisatie met KBO

Datum staging: Apr 3, 2024

Datum Productie: Apr 10, 2024

Versie 8.85.3 Synchronisatie met KBO, bugfixes voor JSON-LD formaat

Datum Staging: Mar 18, 2024

Datum productie: Mar 25, 2024(geannuleerd)

Versie 8.78.0 Verbeteringen aan het sorteren in publieke zoek, output in JSON-LD formaat

Datum Staging: Mar 4, 2024

Datum productie: Mar 11, 2024

Versie 8.53.3 - geen impact op publieke API

Datum productie: Feb 5, 2024

Versie 8.52.0 - verbeteren publieke zoek resultaten, toevoegen korte beschrijving aan publieke zoek

Datum productie: Jan 26, 2024