Cloud Integration – Overview of OData API Documentation

Provides access to the available APIs for Cloud Integration. Clicking a tile, you find documentation for a specific API, for example, Integration Content.

The documentation on SAP API Business Hub contains the essentials required to work with the API. Here, you find:

Documentation of the API resources, the supported operations, query options
Documentation of the structure of the request body (if required) and of the response bodies (for successful and error responses)

Furthermore, you can test GET requests directly on SAP API Business Hub connecting to a sandbox system.

• Background information regarding the Cloud Integration resources that can be accessed to through the API. For example, for the Security Content API you find Help links to the related artifacts like the keystore and the security artifacts.
• Furthermore, you find information on how to use in order to implement a bit more complex scenarios, in particular, when you need to place more than one API call in sequence to get a specific problem solved.

For example, to get the runtime status of a deployed integration artifact, you need to execute several API calls as described at Get Runtime Status of Deployed Integration Flow.

Another example is the scenario how to get properties from message store entries created with the Persist integration flow step. See: Get Message Store Entry Properties.

• You also find information on how to authenticate an API client (for example, Postman) to access Cloud Integration resources through the API. The configuration steps deoend on whether you use Cloud Integration in the Neo or Cloud Foundry environment.
  • Setting Up Inbound HTTP Connections (for API Clients), Cloud Foundry Environment
  • Setting Up Inbound HTTP Connections (for API Clients), Neo Environment