Example: Security type - API Key

In this example, We will create a custom by using Clockify - API Docs.

Steps

Create a Connector
Configure Connectivity
Create an Operation

Create a Connector

Navigate to, Left panel --> More --> My Apps
Click Cerate a new connector
In the Modal, fill out the following elements, then click Save

Title - Clockify
Description -

You can find your API Key in<a href='https://clockify.me/user/settings' target='_blank' style='color:#0057ff;'>your console.</a>

Image URL - https://easyflow-assets.s3-us-west-2.amazonaws.com/stencils/APP_CLOCKIFY_128x128.svg
Host URL - api.clockify.me/api/v1
Security Type - apikey
Active - true

Configure Connectivity

Navigate to, Left panel --> More --> My Apps
Click on Clockify connector
In the Manage modal options, Click Configure Connectivity
Modify the fields and click Save

items [ ] - The API Key name in Clockify Docs is X-Api-Key, the following configuration added based on it.

{
  "annotation": [
    {
      "key": "note_general",
      "value": "You can find your API Key in <a href='https://clockify.me/user/settings' target='_blank' style='color:#0057ff;'>your console.</a>"
    }
  ],
  "items": [
    {
      "component": "ascx_connection_component_textbox",
      "id": "txt_connection_X-Api-Key",
      "name": "X-Api-Key",
      "placeholder": null,
      "required": "true",
      "subTitle": null,
      "tabindex": "0",
      "title": "API Key",
      "type": "text",
      "validationNote": null,
      "isDisabled": null,
      "defaultValue": "null"
    }
  ],
  "urls": [],
  "parameters": [],
  "headers": [],
  "data": [],
  "settings": []
}

Create an Operation

Navigate to, Left panel --> More --> My Apps
Click the connector to be modified
In the Manage modal options, Click Create an Operation (API Endpoint)
In the Modal, modify the fields and click Save

Title - Get workspaces
Description - Get all my workspaces
Method - GET
Path - /workspaces
Popular - true
Parameters - JSON editor to add the endpoint parameters

[
  {
    "description": "",
    "in": "header",
    "name": "content-type",
    "required": false,
    "type": "string",
    "isHidden": true,
    "default": "application/json"
  },
  {
    "description": "API KEY",
    "in": "header",
    "name": "X-Api-Key",
    "required": false,
    "type": "string",
    "isHidden": true
  }
]

Updated on: 15/11/2022