Authenticatie met API Key

De WFS-verbinding kan worden beveiligd door middel van een API Key. Een API key is één geheime waarde (een string) die de bron uitgeeft en herkent. Bij elk verzoek wordt die sleutel meegestuurd in een HTTP-header; de bron controleert de sleutel en geeft alleen dan data terug. Wie de sleutel heeft, mag de data ophalen — behandel hem dus als een wachtwoord.

Hóe een bron de sleutel verwacht, verschilt per systeem. Twee dingen bepalen dat:

de header-naam waarin de sleutel meegaat (bijvoorbeeld Authorization, x-api-key of apikey);
het formaat van de headerwaarde, waarbij de sleutel ergens in die waarde staat (bijvoorbeeld Basic <key>, Bearer <key>, of kaal <key>).

Voorbeelden van hoe het verzoek er dan uitziet:

Header-naam	Waarde-formaat	Verzonden header

Header-naam	Waarde-formaat	Verzonden header
`Authorization`	`Basic <key>`	`Authorization: Basic <sleutel>`
`Authorization`	`Bearer <key>`	`Authorization: Bearer <sleutel>`
`x-api-key`	`<key>`	`x-api-key: <sleutel>`

Wat de organisatie moet aanleveren

Om de koppeling met een API key in te richten, hebben we van de bronpartij nodig:

de URL van het WFS-endpoint;
de API key (de sleutelwaarde);
de header-naam waarin de sleutel verwacht wordt;
het formaat van de headerwaarde (bv. Basic <key>, Bearer <key>, of kaal <key>).

Lever de sleutel aan via een veilig kanaal (dus niet via gewone e-mail of chat).