| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| Manage API Key userview element allows you to control access to API documents created with the API Builder. |
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
This is a new feature in Joget DX. |
| Anchor | ||||
|---|---|---|---|---|
|
Figure 1: Manage API Key in a userview
Figure 2: Manage API Key in a userview - Log view
Figure 3: Manage API Key in a userview - New/Edit access
| Name | Description | |||||
|---|---|---|---|---|---|---|
API Key | A unique identifier used to authenticate to an API document. | |||||
| 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 Custom Authenticator plugin here. | |||||
| Custom Authentication Method | Methods available:
Note: API Key is always required regardless of method selected above. | |||||
| 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. |
| Anchor | ||||
|---|---|---|---|---|
|
Figure 4: Manage API Key properties
| Name | Description | |||||
|---|---|---|---|---|---|---|
| Custom ID | Item link slug. Optional field.
| |||||
| Label | Menu label. Mandatory field. | |||||
| API Document Name | Select an API Document that you have created previously in API Builder, for further configuration of access in runtime. |
<PENDING SCREENSHOT>
Figure 5: Manage API Key properties - UI (List)
| Name | Description |
|---|---|
| Button Position |
|
| Selection Type |
|
| Selector Position |
|
New Record Button Label | New record button label to show in listing. |
Edit Link Label | Edit button label to show in listing. |
Delete Button Label | Delete button label to show in listing. |
Custom Header | Custom HTML to show above the listing. |
| Custom Footer | Custom HTML to show below the listing. |
<PENDING SCREENSHOT>
Figure 6: Manage API Key properties - UI (Add)
| Name | Description |
|---|---|
| Cancel Button Label | Cancel button label to show in add new record form. |
| Save Button Label | Save button label to show in add new record form. |
| Message to show after Form saved | Message to show in a browser popup, after new record is saved. |
| Custom Header | Custom HTML to show in header of add new record form. |
| Custom Footer | Custom HTML to show in footer of add new record form. |
<PENDING SCREENSHOT>
Figure 7: Manage API Key properties - UI (Edit)
| Name | Description |
|---|---|
| Readonly | If checked, the form will be rendered as read-only and not editable anymore. |
Display Fields as Labels when in Readonly? | When the form is in read-only mode, determines if values should be displayed as is (label form) instead of being bounded in original input form. |
| Back Button Label | Back button label. Default value: Back |
Save Button Label | Save button label. |
| Message to show after Form saved | Message to show in a browser popup, after a record is successfully edited. |
| Custom Header | Custom HTML to show in header of edit record form. |
| Custom Footer | Custom HTML to show in footer of edit record form. |
<PENDING SCREENSHOT>
Figure 8: Manage API Key properties - Performance & Offline
- Cache Settings
- PWA Offline Settings