Introduction

Manage API Key UI menu handles API call authentication for APIs created with the API Builder.

This UI menu is already bundled in the API Builder plugin.


This menu gives you an overview of the API Keys generated within this Governance App, as well as allowing you to generate or edit new or existing API Keys.

Figure 1: API Keys Menu

Adding New API Key

Figure 2: API Keys Form


NameDescription
API NameCustom API Name.
API KeyAn automatically generated unique identifier is used to authenticate to an API document.
Authentication ModeMethods available:
  • API Key
  • API Key & Token
  • Basic access authentication

Required keys in the request header:

Method

Required Key(s)

API Key
  • api_id (API Document ID obtained from API Properties)
  • api_key (The automatically generated API Key)

API Key & Token

  • api_id
  • api_key
  • token (Value derived from configured token pattern)

Basic access authentication

  • api_id
  • api_key
  • Authorization (Base64 encoded value of username:password)

Example

For username "admin" & password of "admin":

admin:admin → Basic YWRtaW46YWRtaW4=

Domain Whitelist

Domain whitelist to allow API calls.

Example

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

IP Address Whitelist

IP address whitelist to allow API calls.

Example

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

Remark (Optional)Any remark or description for the created API access.
Log request query string, headers, payload & responseLog and print any request query string, headers, payload & response into your Joget log.
  • No labels