Consuming RESTful Service using JSON body parameters

Introduction

This is a scenario for connect a basic SAP-to-REST synchronous interface using JSON body parameters.

SAP PO Certification Preparation Guide

Motivation

I ran into this problem, I had to research about the specific configuration to use JSon as parameters in the body, not in the request header. Next, I’ll share the solution I’ve come up with…

System versions

SAP ECC 7.4 (SAP BASIS 740 SP 23)
SAP PI NETWEAVER 7.4 (SAP BASIS 740 SP 24)

Scenario

We would like to connect SAP ECC to a new RESTful web service, this uses JSON parameters as part of message body, not header. The first request we would connect to get a security identification token. This is the sample request format got from Soap UI:

POST https://xxxx.xxxx.com/api/xxxxService.svc/ExecuteCommand HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 91
Host: xxxx.xxxx.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
{
“__type”:”XXXX “,
“UserName”:”XXXX”,
“Password”:”XXXX”
}

We got this sample result for the request:
{
“Data”: {
“Data”: [ {
“Codigo”: “SecurityTokenId”,
“Descripcion”: “XXXX==”
}],
“Success”: true
}
}
}

Next picture shows the scenario in Soap UI:

We had to consider these annotations:

Use of https requires of SSL certificate
There are not parameters in the header of the request
Media type is settled to application/json
The JSON body parameter contents special characters (“__type”)

Step 1: System Landscape Directory

Transaction SXMB_IFR

1. Create a new product and version

In tab General set vendor and product name

In tab Software Components set a new Product Instance and a new Software Component Version

Step 2: Enterprise service builder

We created these objects:

1. Create software component version, got from SLD

2. Data types for request and response

* The name of field “__type” is not allowed, we had to use XML to JSON name mapping in Integration Builder Communication Channel.

Data Type for response

3. Message Types

Request

Response

4. Service interfaces

Request

Response

5. Message mappings

Request

Response

* Object ns0:mt_aut_response right-click marked “Return as XML”

6. Operation Mapping

Request Tab

Response Tab

Step 3: Trusted CA’s certificate installation

In SAP NetWeaver Administrator / Configuration / Certificates and Keys we installed the CA certificate.

Installed certificate.

Step 4: Integration Builder

We created these objects:

Already existed the Business Systems BS_BNV_D and ECC120UnitTest, they were created in the system landscape directory.

1. Communication channel

SAP XI adapter type (sender):

SAP REST adapter type (receiver):

*At first, we couldn´t see the adapter type REST when we were creating the communication channel, we had to upgrade the version of component XI CONTENT SAP_BASIS 7.40