Versions Compared

Old Version 28

changes.mady.by.user Justin

Saved on

compared with

New Version 29

changes.mady.by.user Justin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescriptionScreens (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 MethodMethods available:
  • API Key
  • API Key & Token
  • Basic access authentication
API Secret (API Key & Token method)A secret string used for authentication.
Token Pattern (API Key & Token method)

Token Pattern consists of hash algorithm and variables.

Format:

  • HASH(
MD5,
  • PATTERN)

Supported hash algorithm:

  • MD5
  • SHA-1
,
  • SHA-256
and
  • SHA-512
) and variables (

Supported variables:

  • {api_key}
,
  • {api_secret}
,
  • {date_pattern} (current date time)
.
Example

Examples:

  • SHA-256({api_key}::{api_secret}::{yyyy-MM-dd HH:mm})
  • MD5({api_secret})


Note

Token pattern must contain at least one and only one hash algorithm.



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:

  • Add as additional authentication method
  • Replace the default authentication method
Note
API Key is always required regardless of method selected here.
Domain Whitelist

Domain whitelist to allow API calls.

Info
titleExample

"localhost;www.joget.org;dev.joget.org”, or "*" to allow from everywhere.

IP Address Whitelist

IP address whitelist to allow API calls.

Info
titleExample

"127.0.0.1;192.168.0.1”, or "*" to allow from everywhere.

RemarkAny remark or description for the created API access.

...