Wat is een API-key?
Een API-key is een geheime reeks tekens waarmee een ander systeem bewijst dat het je gegevens mag lezen. Hij werkt als een wachtwoord, met dit verschil dat een programma hem invoert in plaats van een persoon. Hij blijft geldig totdat je hem intrekt.
Goed om te weten: de Gatherino-editor en je account zijn in het Engels of Tsjechisch. De formulieren die je invullers invullen, kunnen in 18 talen worden getoond, inclusief het Nederlands.
De API-key maak je aan in de instellingen en hij wordt precies één keer getoond. Sla hem meteen op in een omgevingsvariabele of een secret manager op je server. Later kun je hem niet meer opvragen, omdat hij is opgeslagen in een vorm waaruit de oorspronkelijke waarde niet te herleiden is.
De meest voorkomende fout is de API-key in JavaScript op de pagina zetten. Broncode in een browser is openbaar: iedereen kan de key kopiëren en elke reactie op al je formulieren downloaden. API-aanroepen horen daarom op een server die de key bewaart en alleen teruggeeft wat bedoeld is om openbaar te zijn.
Als een key lekt, onderzoek dan niet of iemand hem heeft gebruikt. Trek hem in en maak een nieuwe aan. Intrekken gebeurt direct en de oude key werkt daarna niet meer.
In de praktijk
- De API-key hoort in een omgevingsvariabele aan de serverkant, niet in een repository en niet in de frontend.
- Gebruik bij voorkeur een aparte API-key per integratie, zodat je alleen die ene kunt intrekken.
- Vervang de API-key wanneer iemand die hem kende de organisatie verlaat.
Veelgestelde vragen
Waar maak ik een API-key aan?
Onder Instellingen → API-keys. Hij wordt maar één keer getoond.
Hoe wordt de API-key verstuurd?
In een Authorization: Bearer <key>-header of in een x-api-key-header.
Wat gebeurt er als ik een API-key intrek?
Hij werkt direct niet meer en integraties die hem gebruiken krijgen een 401-fout.
Gerelateerd
Probeer Gatherino gratis
Gratis abonnement: 3 formulieren en 100 antwoorden per maand. Geen creditcard nodig, gegevens gehost in de EU.
Gratis aan de slag →