Example Web API Endpoint

This example walks you through how to create a Web API Endpoint.

Authentication

Before creating an endpoint, you will first need to set up an authentication for your Web API.

  1. From the menu, click the Authentication button. The Web API Authentication table displays any existing authentications.

  2. Click the Create button to open the Create Authentication dialog box. Populate the required fields: 

    • SIC Connection

    • Name

    • URL

    • Authentication Scheme and associated details

      See Create Authentication for details on these fields.

  3. When done, click the Save button.

Services

Setup

After you create your authentication, you must set up the Web API Services.

  1. From the menu, click the Services button. The API Service List table displays all existing services that you have configured.

  2. Click the Insert Row button and populate the Name and Service text fields and choose an Authentication from the drop-down menu. The Authentication field drop-down will display a list of the authentications you have created in SAP Connector.

Test

Verify if your service is reaching SAP successfully using the Test button.

  1. Select your connection from the API Services table.

  2. Click the Test button.

Endpoints

You can now set up your endpoints.

  1. From the menu, click the Endpoints button. Previously created endpoints display in the SAP Web API Endpoints Table.

  2. Click the Create button to open the dynamic sidebar.

  3. In the General step, enter a Name for the endpoint and choose an Authentication from the Authentication Name drop-down menu.

  4. Use the API Service step to select an API Name from the drop-down menu. Options displayed are pulled from the services set up in the Web API Services page.

  5. For Endpoint Type, use the drop-down menu to select from the list of available endpoints. Options displayed dynamically update from previous selections. See 3. Endpoint Type.

  6. Use the Resource Path drop-down menu to select the applicable path. See 4. Resource Path.

  7. Populate the final Query Options step, which includes the following fields: 

    • Set Select Values: Optionally, click the Set Select Values button to choose which data points to include. If you skip this step, all values are included.

    • OneStream Parameter: If your data has a date parameter, optionally enable the OneStream Parameter? setting. See Use Substitution Variables in Web API.

      If you select no, you can set your dates using the integrated date picker to choose your posting date.

    • Filter Text: Populate the Filter text field, if applicable. Content you add will be used to filter your data using the SAP server, increasing your performance.

    • Set Order By Values: Optionally, click the Set Order By Values button to choose to display your data in ascending or descending order. If you do not make a selection, your data will not be sorted. See Set Order By Values.

  8. Click the Save button.

Connector Objects

Create a Connector Business Rule and, optionally, a Data Source for you connector.

  1. Select your connection on the SAP Web API Endpoints table.

  2. Click the Manage Objects button.

  3. Optionally choose to Link to Profile (add DataSource). If enabled, use the drop-down menus to choose your Cube, Import Profile, and Transformation Rule Profile.

  4. Click the Apply button to create your business rule.

You have now successfully set up a Web API Authentication, Service, and Endpoint Connector.