Hoe werkt authenticatie met je API-sleutel?

Voor elke aanroep over https heb je een API-sleutel nodig. De sleutel bepaalt op welk account je werkt: er is geen aparte gebruikersnaam en geen token dat verloopt.

Je sleutel meesturen

Authenticatie gaat via basic auth. Je vult je sleutel in als gebruikersnaam en laat het wachtwoord leeg. In curl zet je een dubbele punt achter de sleutel, anders vraagt curl alsnog om een wachtwoord.

Hoe dat werkt met de knop ‘Try it’ in deze documentatie, lees je bij API uitproberen met Try it.

curl https://api.laposta.nl/v2/list \
  -u JOUW_API_SLEUTEL:

Stuur je geen geldige sleutel mee, dan geeft de API een 401-foutmelding terug:

{
  "error": {
    "type": "invalid_request",
    "message": "No valid API-key provided"
  }
}

Een sleutel aanmaken

Je kunt sleutels aanmaken in je account onder ‘Koppelingen’. Hoe je dat precies doet, wat je daarna nog van een sleutel kunt zien en hoeveel sleutels je kunt aanmaken, lees je bij API-sleutel aanmaken.

Veilig omgaan met je sleutel

Een sleutel geeft toegang tot alle gegevens van het account, dus behandel hem als een wachtwoord.

Werk in plaats daarvan met een omgevingsvariabele of de secrets-opslag van je hostingpartij, en laat de aanroepen vanaf je eigen server lopen. Wil je iets testen, gebruik dan een aparte lijst in je eigen account. Doe dat zeker bij endpoints waarmee je gegevens aanmaakt of verwijdert. Een apart gratis testaccount aanmaken kan meestal niet: zie Eén gratis account per organisatie.

Gerelateerde artikelen