Skip to Content

Expose Integration Flow Endpoint as API and Test the Flow

test
0 %
Expose Integration Flow Endpoint as API and Test the Flow
Details

Expose Integration Flow Endpoint as API and Test the Flow

October 6, 2021
Created by
December 3, 2020
Define the endpoint of the integration flow developed in the last tutorial as an application programming interface (API).

You will learn

  • How to define and expose an integration flow endpoint as an API
  • How to assign a policy to your API
  • How to call your API and execute the integration flow using the API portal
QR code

Prerequisites

  • You have provisioned your SAP Integration Suite tenant and activated Design, Develop and Operate Integration Scenarios and Design, Develop and Manage APIs. For more information, see Set Up Integration Suite Trial.
  • You have created and deployed an integration flow that reads product details using an OData connection. For more information, see Design and Deploy Your First Integration Flow.

Context

In this tutorial, you will define the endpoint of the integration flow developed in the last tutorial as an application programming interface (API).

In addition, you will assign a policy template to the API to define how the API is called. A policy defines, for example, how an API can be called. In this tutorial, you assign a policy that defines an authentication of the API according to OAuth 2.0 client credentials grant. It is a secure way to control access to an API.

After you have performed these steps, finally, you will call the API to fetch the product details.


Step 1: Get endpoint of the integration flow

In this step, you copy the endpoint address of the integration flow.

  1. Go to the Cloud Integration Web UI and open your integration flow.

  2. In the Deployment Status tab of the property sheet, choose the URL.

    Access Deployed Artifact
  3. In the Endpoints tab, choose Copy icon.

    Endpoint URL
Log on to answer question
Step 2: Define the API

In this step, you define and expose an integration flow endpoint as an application programming interface

  1. Go to your SAP BTP trial subaccount. Select Instances and Subscriptions. In the Subscriptions, section, find Integration Suite and select Go to Application.

    Access Isuite
  2. On the Integration Suite welcome page, choose Design, Develop and Manage APIs.

    API management
  3. On the home page, under Quick Actions, choose API.

    Quick actions API
  4. On the Create API dialog, next to Select: choose URL and specify the following parameters:

    IMPORTANT : Paste only the endpoint URL till /http/products Otherwise, the scenario will not run appropriately.

    Parameter Settings
    URL Paste the integration flow endpoint address you have copied in step 1. It ends with /http/products/details. Note: paste only the endpoint URL till /http/products instead of /http/products/details.
    Name RequestProductDetails
    Title Product Details API
    API Base Path /products
    Create API

    Select Create.

  5. On the landing page, choose Resources tab and then Add.

    Add resources
  6. In field Tag enter Product Details, and in the field Path Prefix enter /details.

    Add details
  7. Under Operations, delete all tabs except the POST tab and choose OK.

    Add operations

    The API Resource is displayed.

  8. Choose Deploy to create and activate the API Proxy for your integration flow.

    Deploy
  9. Choose the POST operation to display more details on the API. A default API definition in Open API specification format is also generated.

  10. To update the generated API definition in Open API format, choose Edit > Edit in API Designer.

    Edit API designer

    The API designer is opened.

  11. In the editable section on the right part of the screen, make the following changes.

    Change Payload to productIdentifier and add a row as shown in the following screenshot.

    TIP: Instead of copying the example, type it manually.

    change product identifier beforechange product identifier after

    Choose Save.

  12. Choose the POST request. You notice the API changes, in particular, the request body contains now one element with a product identifier.

    Resources Tab API Changes
  13. When you choose Try Out and then Execute, since no authentication details have been configured, you get an error message with error code 401 (not authorized).

    Error message

    With this step, you have successfully created an API Proxy for your integration flow and generated an API documentation for your REST API in OpenAPI format.

Log on to answer question
Step 3: Copy credentials from service key

In this step, you’ll copy the client ID, client secret, and token URL from the service key that you automatically generated using a booster in Set Up Integration Suite Trial.

  1. Navigate to your service instance page which you earlier opened at the end of Set Up Integration Suite Trial. You can access this from your subaccount. Choose Services > Instances and Subscriptions.

  2. Under the Instances section, look out for the service instance that was created by the booster. Usually the default name that the booster provides is default-it-rt-integration. Choose the key under the Credentials column to open the service key.

    view key

  3. Copy the values of clientid, clientsecret and tokenurl parameters. These are the credentials that you use to make a request to your integration flow.

    Copy clientid and clientsecret

Log on to answer question
Step 4: Assign policy template

In this step, you assign a policy template to your API to specify authentication details for the API call. In particular, you use a policy template that defines that the caller of the API authenticates itself using OAuth 2.0 client credentials grant.

This grant type works in the following way: In a first call, the API client provides the values of clientid and clientsecret (from the service key generated in Step 1) to a token service (the URL of the token service is also contained in the service key definition). The token service provides an access token to the API client. In a subsequent call, the API client calls the integration flow endpoint providing the access token. If the access token is valid, the API client is authorized to call the integration flow.

  1. In the navigation area of API Portal, choose View content packages.

    Discover
  2. Search for the package Connect to SAP Business Technology Platform Services. Choose the package.

    choose API
  3. Navigate to Artifacts tab.

    Artifacts1
  4. Under Actions, choose Copy.

    Actions
  5. After the success message is displayed, navigate to the Develop section.

    Develop API
  6. Choose your API proxy.

    API Proxy
  7. Choose Edit.

    Edit
  8. Select Policies.

    Policies

    The Policy Editor opens.

  9. Choose Policy Template –> Apply.

    Policy Template
  10. Select the template Cloud_Platform_Connectivity and choose Apply.

    add Template
  11. Open the node Target Endpoint.

    TargetEndPoint
  12. Choose PreFlow.

    PreFlow
  13. In the editor, the OAuth workflow defined by the policy is visualized as a graphical model.

    Now, you need the values copied from the service key: clientid, clientsecret and tokenurl.

  14. In the graphical model of the Policy Editor, choose the getcredential shape.

    Graphic Model
  15. Paste the value of clientid and clientsecret as shown in the following image.

    Values
  16. In the Policy Editor, choose the getoauthtoken shape.

    token
  17. Paste the value of tokenurl as shown in the following screenshot.

    Note: Make sure that you append ?grant_type=client_credentials to the token URL that you pasted.

    tokenURL
  18. Select Update.

    tokenURL
  19. Select Save.

    Save
  20. Select Click to Deploy.

    Save

    In this step you have assigned a policy template.

Which of the following values are mandatory to authorize the API client and to call an integration flow as an HTTP endpoint?
×
Step 5: Execute API

In this step you try out the API to get product details as a response from the remote component.

  1. Go to the Resources tab.

    ResourceTab
  2. Choose Try Out.

    try out
  3. Choose Execute.

    Execute
  4. As result, you see the response from the WebShop with the product details for the given product identifier.

    WebShop
Log on to answer question

Congratulations!

You have successfully set up your Integration Suite trial, designed a simple integration flow that reads data from a remote component, and defined the integration flow endpoint as an API. Finally, you have successfully called the API to get product details as a response from the remote component.

This scenario showed you how to use Integration Suite, and in particular, its Cloud Integration and API Management capabilities seamlessly integrated, end-to-end.


Next Steps

Back to top