Skip to main content

Module api_key

Module api_key 

Source
Expand description

API-key extraction from the fixed X-API-Key and Api-Key fields.

X-API-Key takes precedence; Api-Key is consulted only when it is absent. The selected value is returned unchanged, including an empty value. This module selects a text field but does not validate or authenticate it. API keys are sensitive: callers must not log or otherwise disclose returned values, and extraction errors never include them.

Functionsยง

extract_header_api_key
Extract an API key from request fields.
extract_request_api_key
Extract an API key from a complete request.