| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Manage API Key userview menu handles API call authentication for APIs created with the API Builder. This userview menu is already bundled in the API Builder plugin. |
...
| Table of Contents |
|---|
...
Configure API Access
| Name | Description | Screens (Click to view) | ||||
|---|---|---|---|---|---|---|
API Key | A unique identifier used to authenticate to an API document. |
Figure 1: Manage API Key in a userview
Figure 2: Manage API Key - Log view
Figure 3: Manage API Key - New/Edit access | ||||
| Authentication Method | Methods available:
| |||||
| API Secret (API Key & Token method) | A secret string used for authentication. | |||||
| Token Pattern (API Key & Token method) | Token Pattern consists of hash algorithm (MD5, SHA-1, SHA-256 and SHA-512) and variables ({api_key}, {api_secret}, {date_pattern}). Example: SHA-256({api_key}::{api_secret}::{yyyy-MM-dd HH:mm}) | |||||
| Permission Plugin (Basic access authentication method) | Select a permission plugin and configure its properties. Find list of available permission plugins here. | |||||
| Custom Authenticator Plugin | Select a custom authenticator plugin and configure its properties. This option is shown only if a plugin of that type exist in the system. Learn more about API Authenticator plugin here. | |||||
| Custom Authentication Method | Methods available:
| |||||
| Domain Whitelist | Domain whitelist to allow API calls.
| |||||
| IP Address Whitelist | IP address whitelist to allow API calls.
| |||||
| Remark | Any remark or description for the created API access. |
...
Configure Userview Menu
Manage API Key properties
...