Authenticatie

De Avallo REST API gebruikt een API-key voor authenticatie.

Iedere request moet de API-key bevatten in de HTTP-header:

X-API-Key: {apiKey}

Avallo verstrekt de API-key en koppelt hieraan de toegangsrechten van de afnemer.

Request authenticeren

Vervang {apiKey} door de verstrekte API-key:

curl --request GET \
  --url "https://api.avallo.nl/v1/groundwater-monitoring-wells" \
  --header "Accept: application/json" \
  --header "X-API-Key: {apiKey}"

Veilige opslag

Behandel de API-key als een geheim. Neem de waarde niet op in broncode, publieke configuratie, browsercode of logbestanden.

Gebruik voor productie een secrets manager of een vergelijkbare beveiligde configuratiemanager. Voor lokale ontwikkeling raden we sterk aan om een omgevingsvariabele te gebruiken:

export AVALLO_API_KEY="{apiKey}"

Deze kan vervolgens in een request worden toegepast:

curl --request GET \
  --url "https://api.avallo.nl/v1/groundwater-monitoring-wells" \
  --header "Accept: application/json" \
  --header "X-API-Key: ${AVALLO_API_KEY}"

Authenticatie en autorisatie

Authenticatie stelt vast welke API-key wordt gebruikt. Autorisatie bepaalt tot welke gegevens deze API-key toegang geeft.

Statuscode	Betekenis
`401 Unauthorized`	De API-key ontbreekt of is ongeldig.
`403 Forbidden`	De API-key is geldig, maar geeft geen toegang tot de gevraagde gegevens.

Gebruik de HTTP-statuscode als primaire indicatie van het fouttype. Foutresponses gebruiken waar mogelijk application/problem+json.

Vervanging of intrekking

Neem contact op met Avallo wanneer een API-key mogelijk is uitgelekt, niet meer werkt of andere toegangsrechten nodig heeft.

Vervang een ingetrokken API-key in alle configuraties waarin deze wordt gebruikt en controleer daarna of de integratie met de nieuwe API-key werkt.

Gerelateerde documentatie

Zie Aan de slag voor een volledig voorbeeldrequest en Foutafhandeling voor de verwerking van 401- en 403-responses.