Creating an Enterprise Page on SAP API Business Hub

Objectives
After completing this lesson, you will be able to:

After completing this lesson, you will be able to:

  • Create an enterprise page on SAP Business Hub

Create an Enterprise Page on SAP API Business Hub

Scenario

You want to release the previously created API in a centrally accessible place within your organization. To do this, you will create an API Business Hub Enterprise page with the released APIs.

Task Flow

In this exercise, you will perform the following steps:

  • Create an application
  • Find and save the API key
  • Create a Slack channel
  • Find and save the channel ID
  • Save the URL for sending messages

Prerequisites

  • You have created a functioning API in the API Management Portal based on Slack
  • You have created a product

Create an Enterprise Page on SAP API Business Hub

Task 1: Create an Enterprise Page on SAP API Business Hub

Steps

  1. Create an application in API Business Hub Enterprise.

    1. Navigate to the API Business Hub Enterprise page by selecting API Business Hub Enterprise on the top-right of the API Portal home screen.

    2. On the API Business Hub Enterprise start screen, you will find a tile with your created product, Supplier Slack.

    3. Use the menu to navigate to the Manage page.

    4. Select Registered Users in the Manage Users tile.

    5. Enter an e-mail address in the administrator area and acknowledge by selecting the hook.

    6. Select the + icon in the Registered Users area.

    7. On the next screen enter the following data:

      FieldValue
      User IDThe user ID or email address of your trial account
      First Name and Last NameChoose any name
      Email IDThe email address of your trial account
      Assigned RolesAssign all available roles
      ReasonChoose any reason
      Country/RegionChoose any country
    8. Select Save.

    9. The result should look like the following:

    10. Navigate to My Workspace using the menu on top of the screen.

    11. Select the + button to create a new application.

    12. Insert a meaningful name, for example, Supplier Slack App and select the + icon to add a product.

    13. Choose Supplier Slack and choose OK.

    14. Save the created application by selecting Save.

    15. On the resulting page, you will find the Application Key, which is required for all calls. Copy and save it for later use.

  2. Find and save the Application Key.

    1. To find and save an regenerate the Application Key to access this application, navigate to My Workspace and choose your application from the list, for example, Supplier Slack App.

    2. Select the application entry and find the Application Key.

    3. Save it for later use within the Cloud Integration.

  3. Create a Slack channel.

    In a later step, you want to send a notification to a Slack channel. Therefore, you need to create one manually.

    1. Navigate to Home and select your API tile, for example, Supplier Slack.

    2. Select ChannelsPOST /channels and choose the Try out button.

    3. Insert the previously saved API Key into the Authorization header field.

    4. Insert in the body object > name: purchaseorder<current date> (for example, purchaseorder031021) and choose Execute .

      Hint
      The name of the channel has to be in lowercase notation.
  4. Find and save the channel ID.

    1. If the request is successful, you retrieve a response containing the created channel. Look for the ID of your channel in the response message. Save it.

    2. After that, you can check again with a GET request. To do this, select the Slack tile to open the API. Navigate to channelsGET/channels{channelId}. Enter the API key and channel ID in the requested fields.

  5. Copy and save the required URLs for later use.

    1. Navigate to channelsPOST /channels and choose the Try outbutton.

    2. Insert the previously saved API Key in the Authorization header field and the channel ID in the channelId field.

    3. Insert a test message into the "text": property in the body, for example, check031021. Then, select Execute.

    4. Copy the Request URL and save it for later use.

    5. Now you can open your workspace in Slack to find your newly created channel with the message.

      Summary:

      You have deployed a working API in API Business Hub Enterprise. The API can now be used for communication in the next steps.

Save progress to your learning plan by logging in or creating an account