Authorization
header in their requests. The Authorization
header should contain a valid API key that is used to authenticate the request. There are 2 ways to include the Authorization
header in your requests:
Authorization
header with the Bearer keyword to handle API keys. This method is also common for other tokens, such as those generated by OAuth.Authorization
header.
x-api-key
header is a popular custom header for passing API keys, widely used due to its adoption by AWS API Gateway.
Example usage:
username:password
content needs to be base64-encoded. Most request libraries handle this encoding automatically.
Active
: The API Key is valid and authorized to access the requested resource.Inactive
: The API Key has been deactivated and is no longer authorized to access the requested resource.Expired
: The API Key has expired and is no longer authorized to access the requested resource.Rate Limited
: The API Key has exceeded the rate limit and is temporarily blocked from accessing the requested resource.Usage Limited
: The API Key has exceeded the usage limit and is temporarily blocked from accessing the requested resource.Invalid Scopes
: The API Key does not have the required scopes to access the requested resource.Invalid
: The API Key is invalid and cannot be used to access the requested resource.