API Key

Connection to an API authenticated by a static API key sent verbatim in a request header. The key value is used exactly as given; no Bearer prefix is added, so for a bearer scheme include it in the key value yourself (e.g. header Authorization, value Bearer <key>), or use a vendor header like X-Api-Key.

• API category: Generic
• Needs login: No, two-legged: no end-user interaction is required

Configuration parameters

Required

• header : string; required
  Bare name of the HTTP request header that carries the key, with no trailing colon or spaces (e.g. Authorization or X-Api-Key).
• apiKey : string; required
  The secret value placed into the header verbatim (no Bearer prefix is added; include it yourself if the scheme requires it). $VAR references anywhere in the value are substituted from environment variables; write $$ for a literal $.

What components can use this API

Concepts:

• API Tester
• API Upload Tester

Ingredients:

• Call API endpoint (in formIngredients)
• Call API endpoint (in rowActionsIngredients)
• Call list API endpoint (in rowActionsIngredients)
• Load list column from API endpoint (in rowActionsIngredients)
• Paginated API GET (in rowActionsIngredients)
• Render as file link (in customShowIngredientsList)
• Render as image (in customShowIngredientsList)
• Set via API call (in setterIngredientsList)