Deze gids is bedoeld om te helpen bij de opzet van een integratie traject met het verenigingsregister. Niet alleen geven we hierbij wat er allemaal bij komt kijken, maar geven we ook praktische tips mee voor veel gebruikte use cases. Deze gids bevat veel verwijzingen naar andere stukken documentatie die in meer detail gaat, zoals bijvoorbeeld de API documentatie.

Dit is een gids in opbouw. Naarmate de tijd vordert, zal je hier meer en meer nuttige tips en tricks terugvinden.

Denk je zelf aan iets dat hier nog ontbreekt, stuur ons dan zeker een berichtje.

Wat wil je realiseren?

Om te beginnen, geven we al aan dat er verschillende soorten integratie zijn. Deze zijn beide bedoeld voor verschillende doeleinden en sluiten elkaar niet uit. Je kan dus een van deze kiezen of een combinatie er van.

Een set van verenigingen tonen op een publieke website

Doel: Ik toon op een publieke website een lijst van verenigingen met een bepaald karakter.

Voorbeelden:

verenigingsgids = alle verenigingen van mijn gemeente
Ledenlijst = alle verenigingen die lid zijn van mijn koepel organisatie

Voorgestelde oplossing:

Om dit te realiseren, gebruik je best de publieke API van het verenigingsregister. Deze API biedt je zowel een zoek als een detail functie. Het voordeel van deze API is dat je enkel gegevens doorkrijgt die je ook effectief publiek mag tonen. Wanneer een vereniging om een of andere reden niet meer publiek mag getoond worden, dan worden deze gegevens ook direct weggehaald uit de zoek en detail functies.

Nuttige tips:

Gebruik van de publieke API (documentatie, toegang aanvragen, extra tips)
Hoe selecteer ik de set van “mijn verenigingen” (link)
Hoe kan ik extra gegevens tonen bij mijn verenigingen (pagina moet nog gemaakt worden)
Hoe kan ik gegevens in mijn lokale toepassing in sync houden met de data uit VR (link)

Mijn interne CRM up to date houden met de gegevens uit VR

(a) als een organisatie die geen overheid is

Doel: Wanneer iemand ergens de gegevens van een van de verenigingen in mijn scope heeft aangepast, dan wil ik dat te weten komen zodat ik deze wijziging ook direct kan doorvoeren in mijn eigen toepassingen/CRM. Omdat ik geen overheidsinstantie ben, heb ik wel niet het recht om alle gegevens van elke vereniging te zien.