API-sleutel aanvragen

Een API-sleutel voor de LIVEEVENTS Public API krijg je van de veiligheidsregio waarmee je samenwerkt.

Waarom dit zo werkt

De gegevens in LIVEEVENTS zijn van de veiligheidsregio. Zij bepalen wie er toegang krijgt en met welke permissies. LIVEOP zelf geeft daarom geen sleutels uit. Wil je als integratiepartner een koppeling bouwen, dan loopt dat altijd via de veiligheidsregio die de data beheert.

De veiligheidsregio kan zelfstandig credentials aanmaken in LIVEEVENTS. Zij kiezen daarbij precies welke permissies jouw credential krijgt: alleen lezen, ook schrijven, alleen op eigen records of breder. Zo houden zij grip op wat er met hun gegevens gebeurt.

Hoe het samenhangt met je contactpersoon

Je hebt bij elke veiligheidsregio waar je een koppeling mee bouwt een vaste contactpersoon. Dat is meestal de functioneel beheerder of de projectleider die de samenwerking begeleidt. Deze persoon heeft toegang tot de instellingenpagina API in LIVEEVENTS en kan de credential voor jou aanmaken.

Wat je vooraf met je contactpersoon afstemt:

• Welke organisatienaam in audit logs moet verschijnen voor jouw partij.
• Welke permissies je nodig hebt. Wees zo specifiek mogelijk.
• Hoe lang de sleutel geldig moet zijn (één of twee jaar).
• Hoe jullie de sleutel veilig overdragen. De sleutel wordt slechts één keer getoond, dus jullie spreken vooraf af via welk kanaal hij naar jou gaat.

In de praktijk

Een nieuwe partner die met de API wil verbinden, krijgt na afstemming een credential met de afgesproken machtigingen. De contactpersoon binnen de veiligheidsregio maakt deze aan en deelt de client_id en sleutel via een afgesproken veilig kanaal.

Loopt je sleutel binnenkort af, of vermoed je dat hij is gelekt? Vraag je contactpersoon om de sleutel te roteren. Je krijgt dan een nieuwe sleutel; de oude vervalt direct. Stem het tijdstip van de wissel af zodat je koppeling geen onverwachte downtime heeft.

Heb je nog geen contactpersoon? Neem dan contact op met de veiligheidsregio waarmee je wilt koppelen. Zij kunnen je doorverwijzen naar de juiste persoon.