Managing integrations and API
This section outlines how to integrate Diligent ESG with Highbond and how to integrate your applications with Diligent ESG.
Configuring a Boards ESG reporting integration
You can now configure Diligent ESG to integrate with Boards so that Boards users can view their own greenhouse gas (GHG) emission data in the Diligent One Platform section. Boards users who have a Board & Leadership Collaboration package as well as a subscription with Diligent ESG can view the following data in the report:
-
GHG emissions by scope
-
Emissions by source category, site, country, and location
Before you can configure the Diligent ESG to Boards reporting integration, you must complete the following tasks:
-
Create a Diligent One access token. For further information, go to .
-
In the Diligent One Results app, add a collection or select an existing collection. For further information, go to .
-
Add an analysis to a collection or select an existing analysis. For further information, go to .
-
Create a data analytic table to save data from Diligent ESG. For further information, go to .
-
Assign a user with the role of ESGBoardsIntegrationAdministrator. A company admin can assign only one user with the ESGBoardsIntegrationAdministrator role in the account. For further information about assigning this role, go to .
Note
This role is only available for accounts who have subscribed to the ESG Board Reporting package.
Note
Do not upload records to the table after you create the table. Skip this step.
Important
Only the user that has been assigned with the ESGBoardsIntegrationAdministrator role can configure the integration.
-
To configure the Diligent ESG to Boards reporting integration, select the Settings icon
and select Manage Settings.
-
Select the Application Settings tab.
-
In the Configure Diligent One integration section, select Edit.
-
Select the Enable Diligent One integration for Company checkbox.
-
In the Integration User dropdown, select the user to be the ESGBoardsIntegrationAdministrator.
-
In the Diligent One target region dropdown, select the region where the company’s Diligent One registration is based.
-
In the Results Table ID field, enter the ID to connect to Results table. You can find this ID in the Tables tab of your Diligent One collection.
-
In the Diligent One Key field, enter the API key to connect with the Diligent One integration.
-
Select Save.
Note
For security reasons, the ID that you enter is encrypted and hidden from view.
After you configure the integration, a user with the Admin role in the Results app publishes the data to Activity Center. For further information, go to .
After this you can use your data in Activity Center. For further information, go to .
Note
To see the data set in Activity Center, you must have a Report Admin role.
Sending requests using API
The Diligent ESG API is the developer interface for Diligent ESG platform. You can use the API to send activity entry (usage) data to Diligent ESG from your internal systems. For further information about how to use Diligent ESG API, go to Diligent ESG - Accuvio API.
Important
You must have your organization's company ID to send an API request. For further information, go to Copying your company’s ID.
For these steps, we are using a Chrome browser, but you can use other browsers with comparable REST extensions.
-
Install REST Client APIsHub as an extension to your Chrome browser.
-
In your Chrome browser, select the Extensions icon
and select REST Client APIsHub.
-
In REST Client APIsHub, in the GET field, enter https://eco-api.accuvio.com/v1/{CompanyID}/activities but replace {CompanyID} with your organization's company ID. For example, https://eco-api.accuvio.com/v1/312/activities where the {CompanyID} is 312. In this example, you would receive a list of activities that have been configured for your company with the ID 312.
-
Select the Headers tab, and in the Attribute Name field, enter Authorization.
-
In the Attribute Value field, enter Bearer followed by your organization’s API key.
-
Select Send.