Configuration for Using APIs

Sometimes the standard functions that are provided by the apps for the SaaS applications of SAP Integrated Product Development don’t map completely to the way you do your business. To enable you to adapt and extend the standard business processes, SAP Integrated Product Development provides public APIs on the SAP Business Accelerator Hub.

As part of the entitlement for SAP Integrated Product Development, in each of your subaccounts, you can subscribe not only to each SaaS application but also create a service for using a application-specific API. For the created service, you have two options to use the service:

Create a service key to obtain the credential
Bind the service to a BTP application

The following SaaS applications provide public APIs:

Collaboration
Visualization
Engineering including two functions: Requirements Management and Systems Modeling and Test Management
Common Functions
Formulation. For more information, see Using Formulation APIs.
Product Data Integration

For more information, see Usage Guide for Consuming the Product Data Integration API.
Specification Management

For more information, see Using APIs.
Enterprise Product Structure

To add the service plans needed for the public APIs, in the SAP BTP Cockpit, search for and select the relevant service:

SaaS Application	Service	Option to Choose for Service Plan
Collaboration	Collaboration	standard
Visualization	Visualization	standard
Engineering	You need to add the following two services: Engineering SAP EA Designer, cloud edition for the Requirements Management and Systems Modeling	For Engineering, choose standard. For SAP EA Designer, cloud edition, choose system-modeling.
Common Functions	To use Common Functions, you need add Authorization and Trust Management service.	standard
Formulation	Recipe Formulation	standard
Product Data Integration	Product Data Integration	standard
Specification Management	Specification Management	standard
Enterprise Product Structure	Enterprise Product Structure	standard

For general information about how to enable APIs, see Administration and Operations in the Cloud Foundry Environment.

For detailed information about most of the APIs, see the SAP Integrated Product Development on SAP Business Accelerator Hub and about the Specification Management API, see the SAP Integrated Product Development Specification Management on SAP Business Accelerator Hub.

Settings Specific to the Visualization SaaS Application

Service Credentials

The newly created Visualization service credentials (in service bindings and service keys) no longer contain properties with a -url suffix. These properties were previously deprecated. Existing Visualization credentials can still contain these obsolete properties.

The api object in the endpoints object in the Visualization credentials contains the base URL that should be used for accessing Visualization APIs. The endpoints other than the api endpoint in the endpoints object are now deprecated.

Sample Code

{
  //...
  "endpoints": {
    "api": {
      "url": "https://api.ingress.eu20.ve.shoot.live.k8s-hana.ondemand.com/app",
      //...
    },
    //...
  },
  //...
}