API Integration using Webhook- Mode 1

API Integration using Webhook- Mode 1

Using Webhook Feature in Asset Infinity

Api Integration for Asset Infinity can be achieved through webhook feature of the application/software wherein Asset Infinity as a subscriber, consumes the API published by any other company.

A user can follow the given path to navigate to Integration settings for authorizing, triggering, and maintaining logs in webhook-

Menu> Advanced Settings> Integration Settings

 

Webhook

Webhooks are HTTP callbacks that are triggered by specific events. They allow you to automate the flow of data between different applications.

Configuring Webhooks in Asset Infinity

Follow the below steps to configure webhooks in Asset Infinity:


Step 1- Webhook Authorization: The first step in configuring webhooks is to authorize the connection between Company 'XYZ' and Asset Infinity. This can be done by providing the necessary authentication credentials to the webhook page in Asset Infinity.

As the user clicks the Webhook Authorization section, Webhook Authorization page opens as shown in the image below-




The user is required to fill the details in the fields as discussed below-

 

i)  Auth Type- A user can select the type of authentication from the dropdown menu to configure the authorization type of an organization’s API for authentication purpose.



ii) Auth Type Description- A user can add description of the Authentication Type describing its use, purpose etc. in the text field.



iii) Token- A user can define a token here in the text field in case the selected Auth Type is Bearer Fixed Token. This token is fixed, and the same token can be used every time the API is invoked.



iv) Auth URL- A user can hit this URL to generate the token for accessing the API. This Auth URL can be defined in case the selected Auth Type is Bearer Runtime Token. This token is for one time use and a different token is generated every time the API is invoked.


v) Request Data- The credentials required login to an organization’s application such as the Organization Name, Email, Password etc. are passed here in JSON format. A user can enter the request data in the text field here. This request data is passed against the Auth URL and is required only when the selected Auth Type is Bearer Runtime Token or a token which is not fixed.




vi) Username- A user can set a username to access an API in case the selected Auth Type is Basic.


 


vii) Password- A user can set Password for defined username in case of ‘Basic’ Auth Type.




viii) Is Active- The Webhook Authorization can be activated/ enabled by setting this toggle to YES and can be made inactive by disabling it.

 


Step 2- Webhook Triggers: The next step is to set up the webhook triggers. These are the events that will trigger the webhook to send a request to the API published by a Company. For example, if Company "XYZ" publishes an API that sends a notification when a new asset is added, the webhook trigger in Asset Infinity would be set up to send a request to the API when the asset is added.

As the user clicks the Webhook Triggers section, Webhook Triggers page opens as shown in the image below-




The user is required to fill the details in the fields as discussed below-

i) Web API - A user can select web API from the dropdown menu. This API will be called when the Webhook/URL configured in the URL field is invoked.



 

ii) URL – The URL configured in this field is the webhook that will be triggered, sending request to the API when the API is invoked.



iii) Authorization –A user can select the Authorization from the dropdown menu which is actually the Webhook Authorization that was configured under Webhook Authorization.




iv) HTTP Method – A user can define the HTTP method for calling the API. The Method can be set as GET or POST.


iv) Is Active – The Webhook trigger is enabled or made active by setting the toggle to YES and can be made inactive by disabling it.

 



Step 3- Webhook Log: This is a log that records all webhook requests and responses. It is useful for troubleshooting and debugging any issues that may arise during the integration process.
​








    • Related Articles

    • API/ File Integration Modes

      API/File Integration between Asset Infinity and other applications APIs (Application Programming Interfaces) are a set of protocols that allow different software applications to communicate with each other. The integration of APIs has become crucial ...

    • Adding Assets using Mobile App

      Adding Assets using Mobile App    First login to the mobile application. The below screen appears    Click on the + sign. Click on the option Add Asset.        Most of the main fields are mandatory and demands the most basic details of an asset.     ...

    • Exploring NFC Tag Integration in Asset Infinity

      Introduction Asset Infinity has implemented NFC (Near Field Communication), a short-range wireless technology to share data. Like Bluetooth and Wi-Fi, and all manners of other wireless signals, NFC works on the principle of sending information over ...

    • Updating the asset code using mobile app

      Updating the asset code using mobile app Enter the organization name followed by the email and password. (The login credentials are the same) Once you login, you can select from the options available on the screen. Click on ‘Dashboards’, this will ...

    • Scanning RFID tags using Asset Infinity

      In continuation to 'Setting up the Chainway C72 for RFID scanning', we will now look at how to scan the RFID tags using the mobile app of Asset Infinity. Once you login to the app, on the home screen click on the lens icon. Please refer to the ...