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

Instructions to 'Add API'

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

• Click the 'Add API' button

Label	Action	Description/Example
Name*	Give a name to the API.	ITSM API, For NMS, etc.
Content-Type*	Select API content type using the drop-down menu.
Authentication Type*	Select authorization type from the given option.	Additional fields appear based on the selection. Refer to the below section for auth-type-based fields.
Base URL*	Add base URL
Description	Add a brief description of the API
Header Parameter	Use the 'Add Parameter' button.	Add Key, Value, and enable the Query Parameter, if required.

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.