Testing APIs in SAP Integration Suite

In this blog post, you'll learn how to test APIs in SAP Integration Suite.


We’ll examine the various API testing options available and the measures that must be taken if an API fails a test. We’ll dive deeply into API debugging in this post.


To comprehend an API’s behavior at runtime, testing is necessary. You can test your APIs using the API test console offered by API Management. You can examine the resources linked to an API’s resources and carry out the actions using the API test console.


To test an API, follow these steps:

  1. Open the API portal in SAP Integration Suite.
  1. Navigate to Test APIs, as shown here. 

Testing APIs 

  1. Choose the API you wish to test and then add the header for the URL parameters to the API endpoint.
  1. Click the Headers button and add the API key, which you can generate by following the instructions from the “Finding and Saving Application Keys” section. Add that key into the header, as shown in this figure. 

API Key in Header

  1. Click Send once everything has been added. If you see the Status Code set to 200 OK, the API is functioning properly; if it displays any other code, the API has a problem. The figure below shows the successful testing of an API. 

Successful Testing of the API

  1. If the system returns any errors when testing an API, you can debug the API by selecting Debug, as shown here.

Clicking the Debug Button

  1. You’ll be directed to the debugging page. Select the message step and debug your API, as shown below. Click on the red icon to learn more about an error of any particular step.

Debugging an API


To understand an API’s behavior at runtime, testing is necessary. You can also test your APIs in the SAP Business Accelerator Hub Enterprise UI in a test environment. This approach enables you to perform actions and explore the resources connected to an API. You can test REST-based and OData-based services as well.


To test your APIs in SAP Business Accelerator Hub Enterprise, follow these steps:

  1. In SAP Business Accelerator Hub Enterprise, navigate to the API test console.
  1. Select the API from the left. You can change the operation type as needed in the Choose an Operation dropdown list. The headers and the URL parameters can be maintained according to your requirements.
  1. Click Send once all the details have been set up. You’ll get a result in the form of HTTP codes. You can also see the Body, Headers, and Cookies, as shown here. 

Testing API Console in SAP Business Accelerator Hub Enterprise

  1. The final figure shows the successful test result of the API.

Successful Test Result


Editor’s note: This post has been adapted from a section of the book SAP Integration Suite Certification Guide: Development Associate Exam by Jaspreet Bagga.


SAP Integration Suite Certification Guide
SAP Integration Suite Certification Guide

Preparing for your C_CPI_14 or C_CPI_15 exam? Make the grade with this SAP Integration Suite certification study guide! From API Management to the Integration Advisor, this guide will review the key technical and functional knowledge you need to pass the test. Explore test methodology, key concepts for each topic area, and practice questions and answers. Your path to SAP Integration Suite certification begins here!

Learn More

SAP PRESS is the world's leading SAP publisher, with books on ABAP, SAP S/4HANA, SAP CX, intelligent technologies, SAP Business Technology Platform, and more!