API Registration

APIs or Application Programming Interfaces are added to enable data exchange between Infraon and computers/programs/applications. API integrations are possible with other third-party applications and web services supporting HTTP protocol.

Infraon supports REST API. REST stands for Representational State Transfer that adheres to REST architectural constraints. REST serves as a bridge between the client and the server, allowing communication over HTTP. It enables servers to cache responses, resulting in improved application performance.

The REST-API serves as a single point of entry into the system. Before granting access to the application's resources, it encapsulates the business logic and processes all client requests, including authorization, authentication, data sanitization, and other necessary tasks. Infraon supports the below content types:

• application/json

• application/x-www-form-urlencoded

• txt/plain

APIs use authorization to secure client requests accessing data. While integrating third-party APIs, these credentials are provided by the respective API provider. Based on the API, you can select one of the below Auth Types:

• API Key - Uses a key-value pair in the API's request headers or query parameters.

• Basic Auth - Uses a verified username and password with the request.

• Custom Auth - Uses token-based authorization that requires CSRF URL, token, key, username, and password with the request.

• No Auth - Uses when there is no authorization to request data.

API Supported Operations

• Requests

• Sites

• Technicians

• Assets

• Worklog

Webhook Handler for Workflow

It enables external applications or systems to receive real-time updates when specific events occur in Infraon workflows. It facilitates unified automation and communication between Infraon and third-party tools by invoking a registered API when triggered by workflow conditions.

It allows users to:

• Register external APIs to be invoked during a workflow transition (such as when a ticket moves from Open → In Progress, etc.)

• Enable or disable webhook responses for specific workflow actions.

• Automate actions like sending notifications, updating external systems, or triggering remote scripts without manual intervention.

Instructions to 'Add API'

• Go to Infraon Configuration -> General Settings -> API Registration

• Click the 'Add API' button and refer to the table below for more details:

Label	Action	Description / Example
Name	Enter a name	It helps identify the integration's purpose, especially when managing multiple APIs in Infraon. This will display the name for the API integration you're configuring. Example: JIRA, ServiceNow, etc.
Content Type	Choose from the dropdown	This defines the format of data being sent to the API. Options: application/JSON, text/plain, multipart/form-data, and application/xml.
Authentication Type	Choose from the dropdown	This defines the method by which the API call is authenticated. The correct type must be selected based on the API provider’s documentation. Options: API Key, Basic Auth, Custom Auth, and No Auth.
Username	Enter your username	The username is used to authenticate API calls using authentication methods like Basic Auth. This typically refers to your registered email address or username in the third-party platform. Example: When integrating Jira, this would be your Atlassian email ID, [email protected].
Password	Enter your password	This field is used along with the username to authenticate the API. If you're using Basic Auth, this is often your account password, or an App Password generated from the external platform’s security settings—especially in platforms like Jira or GitHub, where regular passwords are restricted.
Is Base64 Encode	Toggle ON/OFF	When enabled, Infraon will automatically convert the username and password into a Base64-encoded string for APIs requiring that format (standard with Basic Auth).
Secret Key	Enter the token/key.	The secret key refers to an API token or access key required for secure authentication. It replaces or supplements the password in many modern APIs. You can generate this token from the API/Developer settings section of platforms like Jira, Freshdesk, or Salesforce. Example: cJXbGJI2y1oIh3IsnTI5jR6VCJ9....
Client ID	Enter the client ID.	The Client ID is a unique identifier assigned when registering your application in an OAuth2-compliant platform (e.g., Azure, Google, Atlassian). Example: 11853234773……...
Base URL	Enter API base URL	This is the root URL of the third-party API to which Infraon will send requests. It forms the foundation of all endpoint calls. For Jira, it might look like: https://yourdomain.atlassian.net/rest/api.
Enable Webhook Response	Toggle ON/OFF	This option allows Infraon to receive real-time call-back responses from external platforms via webhooks. It ensures Infraon can process workflow actions or status updates triggered externally when enabled. For instance, if Infraon creates a ticket in Jira and Jira later changes the ticket status, enabling webhook response ensures that Infraon receives and updates the ticket status automatically.
Description	Optional input	You can provide an internal description to explain the purpose of this integration. This is not used for functional purposes but is helpful for clarity and documentation. Example: Integration for auto-creating tickets in Jira.
Header Parameter	Enter key-value pairs	Some APIs require additional headers for authentication or custom handling. Here you can define header keys (e.g., Authorization) and assign static values or macros.
Add to Query Parameter	Toggle ON if needed	When enabled, the header parameter is attached to the URL as a query string instead of being sent in the header.

Auth-Type Fields

• API Key - Auth Key, Auth Value, and Add Key to (Header/Query)

• Basic Auth - Username and Password

• Custom Auth - Token details, Key, Request Type (GET, POST), Username, and Password

• No Auth - No credentials required.

Once all the parameters are added, click 'Submit' to add the API. APIs can be edited or deleted using the respective icons.