REST API Settings enable your application to communicate securely and centrally with external REST services. These settings define the basic connection information and authentication methods for the API. The defined REST API settings can be reused in system actions and integration scenarios.
Kuika provides the REST API Settings configuration through the Configuration Manager module.
REST API Settings
Follow these steps to configure REST API settings:
Log in to the Kuika platform.
Select the project you will be working on from the Apps screen.
Open the Configuration Manager module from the left menu.
Click the REST API Settings tab on the screen that opens.
Click the ADD NEW button.
REST API Settings Configuration
Fill in the following fields on the REST API settings screen that opens:
General Fields
Name (Required): This setting is used to identify the REST API connection. This name is displayed when selecting the relevant API setting in actions.
Base URL (Required): Specifies the base address of the API. All endpoint calls are made through this URL. Example: https://api.example.com
Authentication Type
The REST API Settings screen supports different authentication methods:
No Auth: Used for APIs that do not require authentication. When this option is selected, no additional authentication field is displayed.
Bearer: Used for APIs that require token-based authentication. It typically works with the Authorization: Bearer <token> header.
Basic: Used for APIs that require authentication with a username and password.
Username (Required): The username used for API access
Password (Required): The password used for API access
API Key: Used for services that require authentication with an API key.
Client ID Key Name: Header or parameter name (e.g., client_id)
Client ID: Client ID provided by the API
Client Secret Key Name: Header or parameter name (e.g., client_secret)
Client Secret: Secret key provided by the API
Saving REST API Settings
After filling in all fields:
Click the CREATE button to save the REST API settings.
The saved settings become selectable in system actions and integration scenarios.
