Overview

API Configuration is the process of configuring the parameters and settings necessary for an Application Programming Interface (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. 

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

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 Application 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 Department from the drop-down menu. It is a unit in an organization that provides support to different functions. Example: IT, Facilities etc.
Active	Active Switch must be turned on while configuring a new API.
Icon	Choose an icon to be uploaded for the specified API. The maximum upload file size is 1MB Image dimensions should not exceed 50px X 50px Supported imag formats are .gif, .jpeg, .jpg, .png, .bmp. The images will display as shown below while using the Call API functionality.

API Details

Figure: API Details page

The API Details section lists the following field that needs to be defined. For more informatin, 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
URL	Specify a validated URL.
Authentication
Authentication Type	Choose the predefined values from the drop-down list. Example: No Authentication, API Key, Bearer Token, Basic, OAuth 2.0.
URL	Enter the URL details for the API.
Authentication Types	No Authentication
	API Key - Specify the Key and Value
	Bearer Token - Enter the Token details.
	Basic - The User Name and Password is displayed.
	OAuth 2.0 - Select the Grant Type as Password Credentials or Client Credentials. Subsequently fill in the Grant Type, Token URL, Client ID, Client Secret, User Name and Password, Confirm Password and Scope.
Params
Key	Specify a name for the Key.
Value Type	Choose the Value Type from the drop-down list. 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. Example: Static or API.
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. For example, Text, JSON, XML.
Response
Description	Specify the format of Response from the drop-down menu. For example, Text or JSON.
Add to List	Choose the button to add the configured parameters to the list.

The last section Configured API displays the list of Configured API with the following details.

Figure: Configured API