Deze site biedt informatie over het gebruik van de IPSO.community widgets, het opnemen van de widgets op
een website en het gebruik van de API.
Widgets
Er zijn drie widgets beschikbaar:
Kalender
Aankomende activiteiten
Inschrijven voor een activiteit
Gebruik de opties bovenaan om een voorbeeld van de widgets in te zien voor jouw centrum.
Om een widget op de eigen site op te kunnen nemen moet code opgenomen worden in de (bron van de)
website.
Deze code zorgt er met een unieke sleutel voor dat de koppeling met de juiste data en instellingen
in IPSO.community wordt gemaakt.
De vormgeving van de widgets kan middels CSS aangepast worden door de styling te overrulen of aan te vullen.
Alle classes in de widgets beginnen met tmb-
API
De API biedt verschillende endpoints waarmee een programmeur direct met de data van de activiteiten kan werken.
Kalender widget
Om deze widget op te nemen in een website dient deze HTML code opgenomen te worden.
- Vervang [ID] met de juiste ID (deze kan je in IPSO.community instellen).
- Zorg er voor dat de juiste domeinen zijn vrijgegeven in IPSO.community.
- Gebruik voor de test omgeving https://api.test.ipso.community/ ipv https://api.ipso.community/
- De ID van de div is vrij instelbaar, zorg er wel voor dat deze uniek is op de pagina en dat deze
is opgenomen in data-container
Voorbeeld op basis van de huidige data van het centrum
Aankomende activiteiten widget
Om deze widget op te nemen in een website dient deze HTML code opgenomen te worden.
- Vervang [ID] met de juiste ID (deze kan je in IPSO.community instellen).
- Zorg er voor dat de juiste domeinen zijn vrijgegeven in IPSO.community.
- Gebruik voor de test omgeving https://api.test.ipso.community/ ipv https://api.ipso.community/
- De ID van de div is vrij instelbaar, zorg er wel voor dat deze uniek is op de pagina en dat deze
is opgenomen in data-container
Voorbeeld op basis van de huidige data van het centrum
Inschrijf widget
Om deze widget op te nemen in een website dient deze HTML code opgenomen te worden.
- Vervang [ID] met de juiste ID (deze kan je in IPSO.community instellen).
- Zorg er voor dat de juiste domeinen zijn vrijgegeven in IPSO.community.
- Gebruik voor de test omgeving https://api.test.ipso.community/ ipv https://api.ipso.community/
- De ID van de div is vrij instelbaar, zorg er wel voor dat deze uniek is op de pagina en dat deze
is opgenomen in data-element.
- Indien de instelling "Zichtbaarheid widget" is ingesteld op 'Onderdeel van de pagina' zal de inhoud van
dit element vervangen worden, is het ingesteld op 'Pop up' dan zal het element klikbaar worden.
<divid="inschrijven-container">Klik hier om in te schrijven</div><scriptdata-key="[ID]"data-element="#inschrijven-container"src="https://api.ipso.community/calendarWidgets/v2/javascript/registrationWidget.js"></script>
Voorbeeld op basis van de huidige data van het centrum
Klik hier om in te schrijven
API
De API van IPSO.community biedt aan verschillende partijen informatie. Voor de centra zijn onderstaande
endpoints beschikbaar.
Activities
/api/Activities/GetCalendarActivities [GET]
Op basis van een datumbereik zijn, optioneel voor een specifiek activiteitstype, alle geplande momenten met hun eigenschappen beschikbaar.
/api/Activities/GetCalendarByActivity [GET]
Op van een datumbereik en een specifieke activiteit zijn alle geplande momenten met hun eigenschappen beschikbaar.
/api/Activities/GetActivityInfo [GET]
De details van een specifieke activiteit zijn beschikbaar.
/api/Activities/GetParticipants [GET]
De deelnemers van een specifieke activiteit zijn beschikbaar.
/api/Activities/AddParticipant [POST]
Deelnemers kunnen worden toegevoegd aan een gepland moment.
/api/Activities/AddParticipantToMultiple [POST]
Deelnemers kunnen worden toegevoegd aan een geplande momenten.
/api/Activities/DeleteParticipant [DELETE]
Deelnemers kunnen worden verwijderd van een gepland moment.
ApiSettings
/api/ApiSettings/GetApiKeySettings [GET]
Informatie over de gebruikte API key is beschikbaar.
/api/ApiSettings/GetAllFilterValues [GET]
Alle filters zijn beschikbaar.
/api/ApiSettings/GetWalkInAndOpeningHours [GET]
Alle openingstijden en inlooptijden zijn beschikbaar.
API keys kunnen in IPSO.community ingesteld worden.
Documentatie van de endpoints is beschikbaar via swagger: https://api.ipso.community/swagger/ en https://api.test.ipso.community/swagger/
Datums moeten als volgt worden geformatteerd: YYYY-MM-DD (2025-12-31)