API Properties

Introduction

The API Properties allow you to configure various details related to your API in Joget. These settings ensure that your API is correctly identified, described, and secured for internal use and when exposed to external systems.

Get started

To begin configuring your API Properties, you'll need access to the API Builder in Joget. This guide will help you through the necessary steps to set up and manage your API.

Configure API properties

Go to select API Builder > Settings > API Properties and fields configure need.

Fields to configure:

• API ID: This is an auto-generated unique API ID that identifies your API within Joget.
• API Document Name: Enter a name for your API document. This will help you and other users recognize the API.
• Description: Provide a brief description of your API document. Include relevant details that describe the API's functionality.

Document info

You can add miscellaneous information (such as ToS URL, contact name & email, license details, etc.), to append to the API Document.

Fields to configure:

• Terms of Service URL
• Contact Name
• Contact Email
• License Name
• License URL
• External Document URL
• External Document Description

Advanced settings

Fields to configure:

• Enable API for Internal Use: Enable this option if you want a convenient authentication method for APIs consumed internally within Joget. By enabling this, internally consumed APIs no longer require configuration from the Manage API Key Menu userview menu. Instead, you can set a fixed internal API key that persists upon app import/export across different Joget instances.
  
  Note:
  API calls from an external environment still require proper API key management via the Manage API Key Menu.

  Example Script:
  Here is a sample script that utilizes the internal API key for API calls within Joget:

  <script>
  $(function(){
      $.ajax({
          url:'http://localhost:8080/jw/api/assignment/list',
          dataType:'json',
          async:true,
          headers:{
              api_id : 'yourApiDocIdHere',
              api_key : 'yourInternalApiKeyHere'
          },
          type: 'GET',
          success: function(req) {
              console.log(req);
          }
      });
  });
  </script>

• Internal API Key: Enter a unique key for internal use only. This key will authenticate API calls within Joget.
• Internal API Key Permission: Manage who can call the APIs internally using this key. Configure permissions through the Permission Control settings.