LIVEEVENTS Public API

De LIVEEVENTS Public API is de geautomatiseerde toegangsweg tot de evenementen, adviezen en bijlagen van je organisatie.

Waarom dit bestaat

De informatie in LIVEEVENTS is vaak direct gerelateerd aan informatie in externe systemen, zoals zaaksystemen van gemeenten. De Public API maakt het mogelijk dat die andere systemen rechtstreeks met LIVEEVENTS praten, zonder dat iemand handmatig hoeft over te typen.

Een integratiepartner gebruikt de API bijvoorbeeld om:

• Lopende en geplande evenementen op te halen voor een eigen overzicht.
• Adviezen te lezen en eventueel te beantwoorden vanuit een eigen werkproces.
• Bijlagen te synchroniseren met een centraal documentbeheersysteem.
• Een beperkte set instellingen (zoals plaatsen en gemeenten) op te halen voor referentie.

Hoe het samenhangt met de webapplicatie

De API en de webapplicatie werken op exact dezelfde gegevens. Wat een partner via de API aanmaakt, zie je direct terug in LIVEEVENTS, en omgekeerd. Verschil is alleen het kanaal: de webapplicatie is voor mensen, de API is voor andere systemen.

Toegang tot de API regel je per partner met een eigen credential. Elke credential krijgt zijn eigen set permissies, zodat je per partner bepaalt of zij alleen mogen lezen, ook mogen schrijven, en of zij bij alles van de organisatie mogen of alleen bij wat zij zelf hebben aangemaakt. Lees meer in [API-credentials beheren] en [Een API-sleutel aanvragen als partner].

In de praktijk

Een gemeente die haar eigen zaaksysteem wil koppelen, krijgt van de veiligheidsregio een client_id en een sleutel. De leverancier van het zaaksysteem koppelt het systeem met behulp van de LIVEEVENTS API, maakt automatisch evenementen aan of haalt de evenementen op en synchroniseert eventueel de bijlagen. Wijzigingen verschijnen dan automatisch in LIVEEVENTS.

Een eigen interne tool die alleen overzichten nodig heeft, krijgt een credential met uitsluitend lees-permissies. Een partner die actief bijlagen moet kunnen uploaden, krijgt een credential met schrijf-permissies op bijlagen. Wat technisch mogelijk is, kun je nalezen in de [LIVEEVENTS Public API-documentatie].