API Access Key
- Aryn Wiebe
API Access Key is a common method of authentication. It involves using a unique identifier (i.e., API Key) that has been generated and provided by the API upon registration. This key is used to authenticate and identify yourself when making requests to an API to ensure only authorized systems can access the API.
The key is often included in the request authorization header preceding “Bearer“. In a HTTP request, it would look like this:
Authorization: Bearer <your API Key>However, the usage and format can vary between different APIs, so always refer to the API documentation to confirm the specific requirements.
In the Translator, you would prepare the authorization header as follows:
local apiKey = "sfakjrfsfefhkhkmds" -- provided by the API upon registration
local Headers={}
Headers.Authorization = "Bearer "..apiKeyThe Pipedrive API uses API key authentication, for a practical example see How the Pipedrive adapter works.