Widget for Custom Integration
When we are creating a page using the widgets we have discussed till now, we are using the APIs which are pre-defined. But, some clients require customized APIs that cater to their specific requirements.Β
For example, if an institution wants to add a dedupeο»Ώ check in their journey, then by using the custom integration widget, we can customize the page to integrate the API in the journey, which will check whether the KYC of the person is already done using their PAN information(PAN number).
This widget helps us to customize the APIs according to the needs of the clients and also enables us to combine two APIs and get responses. Custom integrations can provide a wide range of benefits, such as increased functionality, improved user experience, and access to valuable data and insights.
There are three sections that are used in this widget, viz, API Configuration, Input Configuration, and Output Configuration.
This section helps to configure the API that is to be customized for the client.
- Sub Header Text: The sub-header for the page is inserted here.
- API Name: The name of the API that is being created is entered here.
- Realm: Name of the realm for which the API is being configured.
- Task: Β Specifies the task of the API.
- URL: The URL to run the API (Request URL).
- Document expiry in days: The number of days after which the document will expire can also be configured here.
- Save API Responses: By clicking on this check box, all the API responses will be saved and displayed in the Back Officeο»Ώ.
- JSON Format: As we are uploading the input in JSON, we need to check this checkbox.
- Request PreProcess: When we want to add an additional Request before hitting the API we can configure it by selectingΒ 'Open Code Editor'. The editor may then be used to make the necessary changes.
- Response PreProcess: When we want to customize the Response after triggering the API we can configure it by selectingΒ 'Open Code Editor'. The editor may then be used to make the necessary changes.
- Upload Custom JSON Input: Here we upload the custom input in JSON format for the API that we want to create. After uploading the JSON file, we can also see the uploaded data by clicking on the 'Open JSON Editor' button. This JSON file can also be downloaded or a new file can be re-uploaded.
We require certain input data for any API. Both the custom JSON input option in the 'API Configuration' section and the 'Input Configuration' section can be used to provide this data into the custom integration widget.
We can configure the input fields here by using the existing elements present in the widget.
The output configuration section of the widget for custom integration can also be used to specify the request that we get when executing an API.
In the widgets, we can add pre-existing elements to specify the output fields. The Textboxο»Ώ element is usually used when configuring output.
Note: GO does not support nested responses.
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].
ο»Ώ