SAP Cloud Integration – Step towards Building API Based Integrations

[former_member36535]

Update

The below described API artifacts availability depends on your tenant licensing model, more information at https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/997501da152d419d96c92f7bfbd...

Update
Due to unavoidable reasons, the release of below mentioned feature is postponed to next release cycle. Hence, the below mentioned feature will be available with  SAP Cloud Integration version 3.34.*/5.18.*/6.10.* . Updated the blog post's introduction part accordingly. Initially it was planned to release as part of version 3.33.*/5.17.*/6.9.*.

Only renamed type OData API from OData Service will reflect in 3.33.*/5.17.*/6.9.*.

Introduction

SAP Cloud Integration, one of the capabilities of SAP Integration Suite, brings a new feature from version 3.34.*/ 5.18.*/ 6.10.* which takes a step towards strengthening design of API based integration scenarios. In this blog post, information about this new feature will be provided.

REST API, SOAP API and OData API

Users can now create a new integration artifacts of type REST API, SOAP API and OData APIs. OData APIs are the rename of previous OData Services artifacts. These artifacts generate a default integration template which can be further extended to meet API based integration needs.

API Artifacts Menu

 

Note: We are fixing the sorting of these menu entries 🙂

 

Once you select the menu entry, creation dialog will popup

REST API

Select REST API to create an REST API based integration scenario.

Create REST API Artifact

 

Once you create REST API integration scenario gets created

 

 

Clicking on the artifact, integration with basic template is displayed. For REST API, HTTPs sender adapter is added in the template.

REST API Integration Template

 

Add the required endpoint address name fo the HTTP sender adapter. The template can be further extended to fit your API integration scenario

REST API with HTTP Sender Adapter

 

SOAP API

Select SOAP API to create an SOAP API based integration scenario.

Create SOAP API Artifact

Once you create, SOAP API integration scenario gets created

 

Clicking on the artifact, integration with basic template is displayed. For SOAP API, SOAP 1.x sender adapter is added in the template.

SOAP API Integration Template

 

SOAP API with SOAP Sender Adapter

OData API

Note: OData API is the renamed type of previous OData Service

Select OData API to create an OData API based integration scenario.

Create OData API Artifact

 

Once you create, OData API integration scenario gets created

 

Clicking on the artifact, integration with basic template is displayed. For OData API, OData V2 sender adapter is added in the template.

 

 

For OData API artifact, a default method and a sample EDMX file is generated in the template

 

 

Monitoring

Once you extend the API templates and complete the integration scenario, you can save and deploy them.

Deployment View

To view the deployed artifacts, as of now, monitoring doesn't provide a default tile to view the deployed artifacts, you need to create a tile to view them.

Add a tile under Manage Integration Content

Add new tile in Manage Integration Content section

 

Select API type for tile

 

 

Clicking on the tile displays the details

 

Message Processing view

To view the message processing status for APIs, you need to add the tile under Monitor Message Processing section

New tile under Monitoring Message Processing section

 

 

 

If user invokes API endpoint, e.g., a REST endpoint from POSTMAN application, then message processing status will appear in this new tile

 

Invoke REST API endpoint

 

 

Details of the message processing details

 

Note:

1. If you have already deployed the previous OData Service artifacts and created a tile for it, then such previously created tile will be appear as OData APIs.


2. You can repeat the same process to get a tile for SOAP API artifacts by choosing SOAP API type for new tile

 

Next Steps

As mentioned, this feature is a step towards building API based integration scenarios. And there are more supporting enhancements coming.

Considering API Definition

As of now, you might have noticed, in REST API and SOAP API based integration scenarios doesn’t take API definition (e.g., Open API Spec/Swagger JSON for REST API) as source. In the next upcoming increment, implementing an integration considering API definition file shall be supported.

Enhancing the templates

For API based artifacts, the sender adapter selection and validation will be enhanced to match the type of artifact, e.g., only HTTPs adapter as sender for REST API artifact.

 

Summary

This is an initial step towards strengthening SAP Cloud Integration capability to support building API based integration scenarios. As of now, they are integration artifacts with basic templates, but going forwards, more and more API related capabilities shall be added.