API-sleutels

Doelgroep: hoofdkantoor

Met een API-sleutel geef je een externe applicatie toegang tot de gegevens van jouw organisatie. De applicatie gebruikt de sleutel om automatisch gegevens op te halen of te wijzigen.

Een API-sleutel aanmaken

Ga naar Instellingen → Integraties.
Ga naar het onderdeel API-sleutels.
Klik op Sleutel genereren.
De sleutel wordt één keer volledig getoond. Kopieer hem direct en bewaar hem veilig. Daarna is de volledige sleutel niet meer zichtbaar.

Een sleutel gebruiken

De externe applicatie gebruikt de sleutel als zogenaamde Bearer-token. Dat betekent dat de sleutel bij elk verzoek wordt meegestuurd in de header van het verzoek.

Een sleutel intrekken

Als een sleutel niet meer nodig is of mogelijk is gelekt, trek je hem in:

Ga naar Instellingen → Integraties → API-sleutels.
Klik bij de sleutel op Intrekken.
De sleutel stopt direct met werken.

Veelgestelde vragen

Ik ben mijn sleutel kwijt. Wat nu? Je kunt een verloren sleutel niet terughalen. Trek de oude sleutel in en genereer een nieuwe.

Zie ik welke sleutel bij welke applicatie hoort? Je ziet een voorvoegsel van de sleutel. Gebruik dat om sleutels uit elkaar te houden. Noteer zelf bij het aanmaken voor welke applicatie de sleutel bedoeld is.