Integrating 3rd Party Data Resources

1. Step By Step

In order to integrate the data resources, we need to first configure "IntegrationButton" block. To get complete details, please check : IntegrationButton block section

Once the block configuration is completed, we need to follow the below steps:

1.1 Authentication Requirements

Global Forest Watch: You can review the documentation at https://data-api.globalforestwatch.org/ for instructions on how to obtain an x-api-key, though please note by default the key comes with certain limitations. For full access, it is recommended to reach out directly to the company's partner team.

Fire Information for Resource Management System(FIRMS):

Access to FIRMS requires a map_key, which can be obtained via this link. Please note that this key is subject to certain limitations. For unrestricted access, it is recommended to contact the FIRMS support team directly.

Kanop:

  1. Navigate to Application Settings: https://app.kanop.io/settings?tab=applications

  2. Create a new application to generate and obtain your access token.

1.2 API Documentation for Integrations

To explore request options and parameter details, refer to the documentation for each service:

For Kanop:

The KANOP_IO_AUTH_TOKEN must be configured either in the policy-service settings or within the Docker configuration. Similarly, for FIRMS, the FIRMS_AUTH_TOKEN must be specified in the same locations. These tokens can be conveniently located under Integration Tokens.

For Global Forest Watch: You must set GLOBAL_FOREST_WATCH_API_KEY in the policy-service config or in the Docker configuration.

For FIRMS: The FIRMS_AUTH_TOKEN must be configured in the policy-service settings or within the Docker configuration. This token can be located under Integration Tokens.

1.3 Displaying Data in a Grid

To display the retrieved data in a grid, save the responses using the sendToGuardian block with the source set to either auto or database.

Use the documents block combined with the source addon block:

Set "Data type" to "Collection (VC)":

Apply a filter: type = "integration"

1.4 Triggering Data Fetch

To retrieve data from a third-party source, select the “Integration Data” button. The system will execute the configured request and display the returned data.

2. Demo Video

Coming Soon

Last updated