API KEY SETUP

The API Key Setup feature is essential for configuring secure and authorized access to external services through an API. It allows users to define settings such as the process, authentication method, and API key details for communication channels like SMS, WhatsApp, or Email. Users can manage API key setups by creating, editing, or deleting configurations for different stages of a process, ensuring secure integration with external systems.

Prerequisites

The user must be logged in with valid credentials. Additionally, the following must be created:

Required Permissions

  • Can Create API Key Setup
  • Can Edit API Key Setup
  • Can Delete API Key Setup
  • Can View API Key Setup

Accessing "API Key Setup" Form

Step 1: Access the Interface

  1. Click on API Key Setup
  2. Click on Create

STEPS FOR API KEY SETUP

A form will open:

API KEY SETUP FORM

Step 2: Process Configuration

  • Process: Select the process for which the API Key should be set up.
  • Sub Process: Choose the relevant sub-process associated with the process.
  • Sub Sub Process: Specify any further sub-sub-process from the dropdown menu.
  • Stages: Select the stage of the process to which this API key is relevant.

Step 3: Communication Settings

  • Key For: Select communication channel
  • SMS
  • WhatsApp
  • Email
  • WhatsApp Business

Step 4: Authentication Configuration

  • Auth Type: Choose authentication mechanism
  • NoAuth: No credentials required.
  • API Key: Requires Key, Value, and where it is added (Header, Query Params, or Body).
  • Bearer Token: Enter token.
  • Basic Auth: Username and Password.
  • OAuth 2.0: Token and Header Prefix.

Step 5: API Configuration

  • Method Type: Select HTTP method (GET, POST, PUT, DELETE)
  • API URL: Enter the API endpoint

Step 6: Additional Header List

This section allows users to define additional headers that should be included with the API request.

  • Header Name: Input field for the header's key name (e.g., Authorization, Content-Type).
  • Header Value: Input field for the value associated with the header name.

Actions:

  • ➕ Add Row: Include new parameters
  • 🗑️ Delete Icon: Remove specific parameters

Step 7: Custom Parameter List

This section allows the user to add any custom parameters required by the API.

  • Field Name: Input field for the name of the parameter.
  • Field Value: Input field for the value of the parameter.

Actions:

  • ➕ Add Row: Include new parameters
  • 🗑️ Delete Icon: Remove specific parameters

Step 8: Stage Parameter List

  • Variable Name: Variable for stage use.
  • Stage Field Name: Selectable dropdown.
  • Default Value: Fallback value.
  • Add or delete rows as needed.

Step 9: Finalize

  • ✅ Create: Submit the form
  • ❌ Cancel: Discard changes

View or Search API Key Setup

  • View a table with Process, Sub Process, Sub Sub Process, Stage, Auth Type, and Key For.
  • Use the search bar to find specific configurations.

SEARCH OR CREATE API KEY SETUP

Manage API Key Setup: Actions

API KEYSETUP ACTIONS

Delete

  • Click the Delete Icon to remove any created API key setup.

Edit

  • Click the Edit Icon, make the required changes, and click Update to save.