Skip to Content

Getting started with the SAP API Business Hub

test
0 %
Getting started with the SAP API Business Hub
Details

Getting started with the SAP API Business Hub

2020-01-28
Learn how to find and test the API Business Hub.

You will learn

Want to learn more about the new SAP API Business Hub? Not sure where to get started? Find more about how to find and enable the SAP API Business Hub in your SAP Cloud Platform instance. Once you are in the SAP API Business Hub, start learning about and testing one of the many available APIs.


Step 1: Open SAP API Business Hub

Go to the SAP API Business Hub.

SAP API Business Hub page
Log on to answer question
Step 2: Find the APIS in the Hub

On the SAP API Business Hub homepage, select APIs under Content Types to see the available packages in the API Business Hub.

SAP API Business Hub homepage API tile

This will take you to the APIs section on the Homepage. Select the View More link to see all available APIs.

API listing on homepage

This will take you to API listing on the SAP API Business Hub.

Searchable API list page
Log on to answer question
Step 3: Select an API to use

In the search box, type SuccessFactors to find the all Success Factors APIs. Click the Search Icon or hit Enter to search.

Searching the discover all APIs

This will bring up all the APIs relating to SuccessFactors.

Success Factors API search results

Click on the SAP Success Factors Foundation/Platform package.

Selecting the SuccessFactors API

This will bring up the SAP SuccessFactors Foundation/Platform API artifact details.

SAP SuccessFactors API overview page
Log on to answer question
Step 4: Test the API in the Hub

Let’s select an API to test and see some results. Select the User Management tile.

User Management tile on page

In order to test the API in the API Business Hub, you need to login. Click the Log On button at the top of the page to do so.

Log On button in SAP API Business Hub

When you look at the API Documentation again for the GET /User endpoint, you will see a Parameters section with a bunch of fields. To test different query parameters, you need to click the Try Out button on the API endpoint.

try out button on API

This will enable to Parameter fields to make them editable. You can test different query parameters by providing a value in the input of the specified data type for that parameter.

editable fields on User endpoint

The GET /User method will return a list of users from Success Factors. The top parameter tells the query to retrieve only the top n results once all the other filtering is done. We don’t want to see all a users data, only selected data points. In the $select parameter, using the control key for Windows or command key for MacOS, select firstName, lastName, and jobTitle. This will limit the data set returned to this 3 fields for the matching results and therefore reduce the size of the resulting data set. Also set an OData Filtering Expression to show only users named Sami: firstName eq 'Sami'.

Query parameters populated in the API Hub

Once your parameters are all set, click the Execute button at the bottom of the documentation for that method.

Try it out button location

If there aren’t any issues, you will see the resulting request URL and the response body (in JSON) on your page.

Feel free to keep playing around in the SAP API Business Hub to better understand the methods available in the User Management API.

What is the last name of the only user from the results array?
×

Next Steps

Back to top