REST Apps

Create an entry for the App that you want to integrate with via REST APIs. You will reference this App for each REST method you will call.

On the main menu, click Apps and at the top-right corner of the page, click Create App and select REST.

The New App page appears. Set the parameters described in the table below.

Parameter Description
Code

Unique name to identify the App. You will reference in each method you call from this REST App. This field is mandatory.

Type Automatically set to REST. This is a non-editable filed.
Icon

Select the icon that best describes the app. It helps you easily identify the app in the list of apps. If no icon is selected, DRUID default icon per selected app type will be shown in the apps list.

AI Agent Automatically set to the current AI Agent. This is a non-editable filed.
Execution Time

The maximum number of seconds a request is allowed to execute. By default, the timeout for all connector integrations is 60 seconds. This setting will apply to all connector tasks which use this app.

IMPORTANT! To avoid long execution time for an integration with many tasks, the maximum sum of all timeouts configured on an integration is 250 seconds. Whenever this maximum is reached, the execution of the currently running integration task is interrupted and any subsequent integration tasks are no longer executed.
Encryption Type

Enables data encryption on the connector using the AES CGM encryption algorithm and allows authors to encrypt specific data before sending it to external REST apps, by using the Encrypt Data integration task as first task in the desired connector action.

When you select AES CGM encryption algorithm (the only one currently available), two new options are available:

  • Encryption Key – click the Generate button to generate the key, which will be used by the Encrypt Data task to encrypt the data and by the client / 3rd party application to decrypt the data and use it further.
  • Secure encryption with salt – adds a random 64-bits salt to the data before encrypting it. Please note that using this feature requires the client to develop code for data decryption.

For more information, see Encrypt Data.

Base URL Base URL for all further method calls.
Security Type

When making API calls to external REST services, you can use authentication and authorization to ensure that client requests access data securely.

The Druid AI Platform allows you to choose from the following authentication methods, which are available in the Security Type drop-down and two separate toggle-ons:

NTLM security

For Druid on premise deployments, if the client computer and Web server are in the same domain, you can use Windows Challenge / Response (NTLM) authentication. It is the authorization flow for the Windows operating system and for standalone systems. For more information, see NTLM Authentication.

Basic Rest Security

Enables HTTP Basic Authentication for REST API calls. Enter the API username and password required by the target service. Druid automatically adds an Authorization header to every request, containing a Base64-encoded representation of the configured username and password in the format Basic <Base64 encoded username and password>. Similar to Postman, the credentials are sent with each request to authenticate the client. For more information, see Basic Authentication.

Info: Basic Authentication is available starting with Druid version 9.24.
Variables

Integration context variables are specific to connectors and are distinct from Druid variables used within flows. These variables serve as placeholders for storing sensitive information such as usernames, API keys, and passwords securely.

Upon saving the settings, Druid encrypts the values, ensuring confidentiality. However, an option is available to exclude encryption if the integration tasks involve consuming non-sensitive metadata.

IMPORTANT!
  • Once a variable is encrypted, it cannot be decrypted. Therefore, exercise caution when encrypting variables.
  • When making authorization API calls, refer to the integration context variables using the "@" symbol.