API Keys

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. It gives you an overview of the API Keys generated within this Governance App and allows you to generate or edit new or existing API Keys.

Adding new api key

When adding a new API key you will see the following:

Where:

• API Name: Custom API Name

• API Key: An automatically generated unique identifier used to authenticate to an API document.

• Authentication Mode: Methods available:

  • API Key
  • API Key & Token
  • Basic access authentication
    
    

    Required keys in the request header:

    • API Key:
      • api_id (API Document ID obtained from API Properties)
      • api_key (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)
        
        Example
        For username "admin" & password of "admin": admin:admin → Basic YWRtaW46YWRtaW4=

• Domain Whitelist: Domain whitelist to allow API calls (e.g., "localhost;www.joget.org", or "*" to allow from everywhere).

• IP Address Whitelist: IP address whitelist to allow API calls (e.g., "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 & response: Log and print any request query string, headers, payload, and response into your Joget log.