Hoe werkt de beveiliging van de API?

Voor de webservice gelden verschillende beveiligingsniveaus. Er zijn publieke gegevens verzamelingen en methodes en er zijn beveiligde verzamelingen en methodes. Dit wordt in de verschillende pagina's in de handleidingen aangegeven. Bij beveiligde methodes, dient er ingelogd te zijn en dient de ingelogde cliënt de benodigde rechten te hebben.

De verschillende niveaus toegelicht:

• Anoniem gebruik - de methodes die publiek zijn kunnen aangeroepen worden zonder enige vorm van authenticatie. Veelal zijn dit methodes die data gebruiken die in de website ook publiek is. Dit betreft bijvoorbeeld het opvragen van de beschikbare objecten.
• Gebruikersniveau - de gebruiker moet ingelogd zijn en werkt met zijn/haar eigen gegevens. Inloggen gebeurt via de REST interface, zie de user entiteit. Er zijn geen profielen nodig voor een dergelijke gebruiker. Dit is vergelijkbaar met een website waarin een "persoonlijke sectie" is opgenomen. Bijvoorbeeld het tonen van de eigen gegevens of een lijst met boekingen die de gebruiker zelf gemaakt heeft.
• Beheerdersniveau - de gebruiker moet ingelogd zijn en dient een autorisatie profiel te hebben. Afhankelijk van de rechten die beschikbaar zijn in dit profiel, heeft de gebruiker de mogelijkheid data op te vragen en/of te manipuleren. Een complete beheerders applicatie zou kunnen worden gebouwd op deze manier.

Methodes van authenticatie

De gebruikersniveaus - hoger dan anoniem gebruik - zijn op verschillende manieren te bereiken.

• Inloggen via de API
  De API zelf kan gebruikt worden om een sessie aan te maken.
  Dit gebeurt via de API - User.
  Gebruik hiervoor de methode POST user/login. Let op voor het gebruik van het attribuut admin. Zet deze op true voor een beheerders login.
• Basic Auth
  Een methode die veel gebruikt is bij REST api's.
  Zie voor algemene informatie: Open API
  Gebruik de gebruikersnaam + wachtwoord waarmee ook ingelogd wordt in het beheerpaneel.
• Oauth 2
  Zie voor algemene informatie: Open API
  Detail stappen staan hier beschreven.
• JWT
  In ontwikkeling: neem contact op met support voor meer informatie.