- 20 Feb 2025
- 9 Minutes to read
- Print
- PDF
Overview
- Updated on 20 Feb 2025
- 9 Minutes to read
- Print
- PDF
API (Application Programming Interface) Configuration is the process of configuring the parameters and settings necessary for an API to operate properly. This include setting up data formats (such JSON or XML), defining authentication credentials, creating endpoint URLs, and configuring different API behavior choices.
Note
The API Configuration that is set up in the current screen is widely utilized across various modules within our system. This includes, but is not limited to, the following:
Azure User Import: The integration with Microsoft Azure to import user details relies on the API settings for secure and accurate data retrieval.
OKTA AD Import: Similarly, the API Configuration is key for connecting with Okta's Active Directory to import user information in a consistent and reliable manner.
BRD: Business Rule Designer (BRD) module leverages the API Configuration for various operations.
Scheduler: The Scheduler module uses the API settings for tasks that involve interfacing with external services to trigger events or actions at specified times.
SMTP: Simple Mail Transfer Protocol (SMTP) settings for sending out emails are dependent on the API Configuration to ensure emails are delivered securely and efficiently.
SMS: For sending text messages, the SMS module relies heavily on the API Configuration to connect with telecommunication service providers.
Mailbox: The Mailbox module also uses the API Configuration to interact with email services, managing incoming and outgoing communications effectively.
It is crucial to recognize that any changes to the API Configuration could potentially impact all the above modules and their related functionalities. Therefore, extreme caution should be exercised when making modifications to the API settings to avoid any disruptions in service and ensure continuous and seamless operation across the system.
API Configuration can be enabled by GET, POST and PUT methods.
GET method is used to retrieve or get information from a given server using the specified URL.
POST method is used to send data to a server. It is also used for inserting new items to the backend server.
PUT method is used to update an existing resource.
Figure: API Configuration
Let's explore the following use-case.
Use Case User Persona: Application Designer | Solution |
NovaTech is faced with a scenario where they need to get data from an outside server, send data to an outside server, or update an existing resource. | To achieve this, Sam enables the API Configuration to interface with other applications and devices. The API Configuration is invoked successfully to intermediate between the system server and outside servers. |
Configure API
Effective API configuration is crucial for smooth communication between different software systems, ensuring that data is exchanged accurately and securely. To configure API, perform the following steps.
1. Navigate to Design Studio > Module > Designers > API Configuration.
2. Select the Domain and Sub Domain from the drop-down menu. The list of configured API is displayed based on Tenants. To learn more on how to manage the list page, navigate to Manage API Configuration.
Figure: API Configuration List page
3. Click New to add API Configuration.
Figure: Add API Configuration
API Configuration Details
API configuration can be achieved by setting up the following fields. For more information, refer to the table below.
Figure: API Configuration Details.
The API Configuration Details section displays the following fields that need to be defined.
Field | Description |
---|---|
API Config Name* | Specify a unique and identifiable name for the API. |
API Group Name* | Choose a group name from the drop-down menu to group similar API being configured. For example, Internal API, OKTA Active Directory, Others etc. |
Configured For / API Type* | Select the type from the drop-down menu. Example: SMTP Gateway, Teams, Mailbox, Webhooks. |
Domain* | Domain is the highest level of hierarchy. It is the main identity of a parent company with different subsidiaries. |
Sub Domain* | A Sub Domain is the second level of hierarchy. It is chosen as a drop-down menu based on Domain selection. |
Department* | Choose the Tenant from the drop-down menu. It is a unit in an organization that provides support to different functions. Example: IT, Facilities etc. |
Active | Enable the Active Switch while configuring a new API. |
Icon | Choose an icon to be uploaded for the specified API. |
API Details

Figure: API Details page
The API Details section lists the following field that needs to be defined. For more information, refer to the table below.
Field | Description |
API Name | Specify a unique name for the API. |
API Timeout (In seconds) | Choose a numeral for specifying the timeout (In seconds) |
API Type | Choose the API from the drop-down menu. For example, Internal or External. |
Response Type | Specify the Response Type as Array or Object. |
Method | Specify the method available to be configured for the API from the drop-down menu. Example: Get, Post, Put etc. |
URL | Specify a validated URL. |
Add to List |
|
Authentication | |
Authentication Type | Choose the predefined values from the drop-down list. |
URL | Enter the URL details for the API. |
Authentication Types | No Authentication |
API Key - In API configuration, API Key & Value authentication is a method of securing access to an API by requiring clients to provide a unique key-value pair. The API provider usually provides this key and acts as a form of credential to verify and authorize requests. | |
Bearer Token - A Bearer Token is a security token used in authentication and authorization to access protected resources in an API. It follows the OAuth 2.0 authentication framework and is called a "bearer" token because the user (or system) presenting the token is assumed to be authenticated without needing further proof. | |
Basic - Basic Authentication is a simple and widely used method for securing APIs. It involves sending a username and password in the request header, which the server validates before granting access. | |
OAuth 2.0 - OAuth (Open Authorization) is an authentication and authorization framework that allows applications to securely access resources on behalf of a user without exposing their credentials. It is commonly used for third-party API access, such as logging in with Google, Facebook, or GitHub. |
Params | |
Key | Specify a name for the Key. |
Value Type | Choose the Value Type from the drop-down list. For example, Static or API |
API | Choose the selected name for the API. |
API Element | Specify the API Element from the drop-down list provided. |
Value | Select the value field which gets enabled only when the Value Type is chosen as Static. |
Description | Choose a brief description about the parameter. |
Action | Choose the Action button if the configurations need to be deleted. |
Header | |
Key | Specify a name for the Key |
Value Type | Choose from the drop-down list to specify the Value Type. |
API | Choose the selected name for the API. |
API Element | Specify the API Element from the drop-down menu. |
Value | Specify the value. This field gets enabled when the Value Type is set to Static. |
Description | Give a brief description of the Headers. |
Action | Choose the Action button if the configurations need to be deleted. |
Body | |
Request Type | Specify the format of the Body form the drop-down menu. |
Response | |
Description | Specify the format of Response from the drop-down menu. |
The last section Configured API displays the list of Configured API with the following details.
Figure: Configured API
Field | Description |
---|---|
Action | Choose the icons for Actions related to the API. For example, Edit or Delete. |
API Name | The name specified while creating the API is displayed here. For example, Get User ID, Post Message, Create Calendar. |
API URL | The URL to update the action is specified here. |
API Method | The API method that has been specified is displayed. For example, GET, POST, PUT etc. |
Authentication Name | The Authentication name that has been specified is displayed. For example, OAuth. |
Status | The status is displayed as Active or Inactive.
|