API-credentials beheren

Maak en beheer de API-credentials waarmee integratiepartners de LIVEEVENTS Public API gebruiken.

Een integratiepartner is een externe organisatie of dienst die geautomatiseerd evenementen, adviezen, bijlagen of een beperkte set instellingen wil lezen of bijwerken. Denk aan een gemeentelijk planningssysteem dat evenementen ophaalt, een dashboardleverancier die overzichten toont, of een eigen interne tool die bijlagen synchroniseert. Elke partner werkt met een eigen credential en eigen permissies, zodat je per partner precies bepaalt waar zij bij mogen.

Per organisatie kun je maximaal vijf credentials tegelijk actief hebben. Een sleutel wordt slechts één keer getoond en is daarna alleen via roteren te vernieuwen. Verwijder je een credential, dan vervalt de toegang van de partner direct.

Voordat je begint: vraag bij de partner op welke organisatienaam in audit logs moet verschijnen en welke permissies zij nodig hebben.

Zo maak je een nieuwe credential aan:

1. Open links in het menu Instellingen en kies API.
2. Kies rechtsboven Toevoegen om het paneel Nieuwe credential te openen.
3. Vul Naam (uniek) in. Dit is een korte technische identifier (1-12 tekens, kleine letters, cijfers, koppelteken) die in het client_id verschijnt en niet meer wijzigbaar is.
4. Vul Organisatienaam in. Deze naam zie je terug in audit logs en op alles wat de credential aanmaakt.
5. Selecteer onder Permissies wat de partner mag doen. Zie de uitleg per permissie hieronder.
6. Stel Geldigheid sleutel in op één of twee jaar.
7. Bevestig met Aanmaken.

Direct daarna verschijnt het paneel Credential aangemaakt met de Client ID en de Sleutel. Kopieer beide en geef ze veilig door aan de partner. De sleutel zie je hierna nooit meer terug. Vink Ik heb de sleutel veilig opgeslagen aan en sluit het paneel pas dan.

Wat de permissies betekenen

Permissies werken volgens twee conventies:

• Eindigt een permissie op .All, dan ziet de credential alle records van de organisatie. Zonder .All ziet de credential alleen wat zij zelf heeft aangemaakt.
• Voor bijlagen bestaat ook .Basic: alleen de lijst en metadata, zonder de bijlage zelf te kunnen downloaden.

Geef nooit ruimere permissies dan de partner echt nodig heeft. Twijfel je, kies dan eerst de variant zonder .All en breid later uit als blijkt dat zij meer toegang nodig hebben.

Een credential bijwerken

Wil je een naam, omschrijving of de set permissies aanpassen? Klik op een rij om het paneel Credential bewerken te openen. De Naam (uniek) en het Client ID liggen vast en kun je niet wijzigen. Wil je die toch veranderen, verwijder de credential en maak een nieuwe aan.

Een sleutel roteren

Roteer een sleutel als de huidige bij iemand terecht is gekomen die hem niet hoort te hebben, of als de geldigheid bijna verloopt. Open het rij-menu en kies Sleutel roteren. Stel de nieuwe geldigheid in en bevestig. De oude sleutel wordt direct ongeldig. De partner verliest toegang totdat zij de nieuwe sleutel hebben verwerkt, dus stem het moment vooraf met hen af.

Een credential verwijderen

Verwijderen is definitief. Open het rij-menu, kies Verwijderen en bevestig in de dialoog. De partner verliest direct toegang en je kunt de sleutel niet meer terughalen. Wil je een gestopte koppeling op orde houden zonder direct te verwijderen, roteer dan de sleutel en deel de nieuwe niet meer.

Wanneer Toevoegen niet werkt

Heb je al vijf credentials? Dan staat Toevoegen uit. Verwijder eerst een credential die je niet meer gebruikt, en probeer het opnieuw.