ApiKey authentication
An API key is a token that a client provides when making API calls. The key can be sent in
the query string:
GET /something?api_key=abcdef12345or as a request
header:GET /something HTTP/1.1
X-API-Key: abcdef12345or as a
cookie:GET /something HTTP/1.1
Cookie: X-API-KEY=abcdef12345API keys
are a secret that only the client and server know. Like Basic authentication, API key-based
authentication is only considered secure if used together with other security mechanisms such
as HTTPS/SSL.| Parameter | Description |
|---|---|
method |
The method is always ApiKey |
location |
Defines the location where the name-value pair is written. The location can be
header, query, or cookie. The
default location is header. |
paramName |
The name of the header, query param, or
cookie. The default value is api. |
apiKey |
The token. The token can also be provided by the credential supplier. The token
uses the paramName as the credential name. |
See also
