Explaining APIs

Objective

After completing this lesson, you will be able to explain outbound and inbound APIs.

APIs in SAP Sustainability Control Tower

When you want to transfer data from one application to another, you can use an application programming interface (API). Further, when you want to replicate data from your source systems into SAP Sustainability Control Tower or to replicate data from SAP Sustainability Control Tower to your systems, you can use Inbound and Outbound APIs.

Outbound APIs

When you want to transfer data from the SAP Sustainability Control Tower database to your client application, use the outbound APIs.

An outbound API enables you to access and retrieve information about measures or metrics from the SAP Sustainability Control Tower database. You can design customized displays and integrate the acquired data into your custom systems. SAP Sustainability Control Tower has predefined outbound APIs for various use cases. These APIs help you efficiently extract and use data in your custom applications.

SAP Sustainability Control Tower and API services are accessible on multiple data centers. To ensure seamless access, specify the appropriate data center URL when making calls to the service. You can find the relevant data center URL within the API specification, available in both JSON and YAML formats.

The API for sustainability metrics lets you obtain sustainability metric values from your implementation of SAP Sustainability Control Tower. Using this API, you can gain insights into the sustainability performance of your organization along ESG and economic dimensions.

The API for sustainability measures enables you to obtain sustainability measure values from your SAP Sustainability Control Tower implementation. With this API, you can access the essential quantitative data for recording and tracking your organization's performance across ESG and Economic dimensions.

Inbound APIs

You have seen the usage of mass importing data through file uploads or through one of the integrations with other SAP systems (for example, SAP Sustainability Footprint Management).

When you must write data to SAP Sustainability Control Tower for all measures, for basic custom metrics, and custom measures, you can use the inbound API.

Import Data into SAP Sustainability Control Tower Using Inbound APIs

You can use the following two ways for importing, validating, and persisting data for measures and basic custom metrics:

MethodImportValidatePersist
Manual FlowAPI requestManage ESG Data appManage ESG Data app

API Flow:

For measures and

For basic custom metrics

API request

To import more than 10,000 records in one call, you can group multiple API requests.

API requestAPI request

You can use inbound APIs such as push measure and metric data in SAP Sustainability Control Tower.

The push measure data API enables you to push measure data into the Data Provider Interfaces (DPIs) of SAP Sustainability Control Tower. After pushing the measure data, to make it available across SAP Sustainability Control Tower, you can validate and publish it.

The push metric data API enables you to push basic custom metric data into the Data Provider Interfaces (DPIs) of SAP Sustainability Control Tower. After pushing the data, to make the data available across SAP Sustainability Control Tower, you can validate and publish it.

Follow the link to read more about Outbound and Inbound APIs.

Log in to track your progress & complete quizzes