#verifyapikey
The Verify API Key policy enforces the verification of API keys at runtime, which ensures the access of the API by Application with valid API Key. This policy ensures that API keys are valid, have not been revoked, and are approved to consume the specific APIs associated with API products.
The APP key can be passed by the application developer either in the header, query parameters. The policy consists of the following elements:-
Property Name | Description | Examples |
---|---|---|
APIKey | This specifies the reference of the variable containing the api key. This can be set using the attribute ref | The possible ways to set it are as follows:- 1. API Key in Query Parameter named apikey <APIKey ref=”request.queryparam.apikey”/> 2. API Key in header Parameter named apikey <APIKey ref=”request.header.apikey”/> |
API Proxy Examples
Zip Name | Description |
---|---|
VerifyAPIKeyQuery | API Proxy Zip Bundle where in the API Key is passed in the query param |
VerifyAPIKeyHeader | API Proxy Zip Bundle where in the API Key is passed in the header param |