REST Connector

1 Creating a new connector without an authentication
2 Creating a connector with authentication
- 2.1 Basic Authentication
- 2.2 OAuth (Open Authorization)
3 Using the connector in the form

Connectors can be created by using the REST connection. This allows the user to access to a resource. In the following, we will explain the process further. We will create a connector with the REST connection which contains a product list as an example.

Creating a new connector without an authentication

In order to create a connector, please open the page Connector under the Design. Created connector than will be available to use in the Form.

Connector can be created via plus sign or directly with the REST button:

The configuration page allows you to enter the desired connector name. URL which contains the webpage for product information should be entered in the hostname area. HTTP method, limitation for the result size and authentication methods should be selected.

Result size limits the data to be shown with the entered value.
Cache information can be available by clicking the checkbox.

In our example, we used the GET method which you can use for reading the data. You can use other methods available:
POST→ Create and add data
DELETE→ Delete the data
PATCH→ Partial modification to a resource
PUT→ Update the data

Clicking the “Save” button will save the custom connector.

You can easily test the REST connection via the section “Testing“, after saving the connector.

Creating a connector with authentication

If you need an authentication to access a connector URL, you can use either basic authentication or OAuth according to your needs.

Basic Authentication

Basic authentication can be configured via entering the user name and password. In the SAP API, there is an extra configuration feature with the CSRF token. You can configure this feature as well according to your needs.

OAuth (Open Authorization)

This authorization method allows you to avoid constant user name and password transfer with a token to secure the access. You can configure this authorization method with user information alongside with the OAuth token information.

Using the connector in the form

Custom connectors can be used in the form. In order to show our example, the product list, in the “Select” element of the form, “Connections” section should be opened. The label and the value will be selected from the REST file, which contain information of the products.

Parameter	Description	Example

Parameter	Description	Example
Connection 1	Custom connectors can be reached via this drop-down list.	Products
JSON Path: label	This area determines the parameter which should be shown in the form drop-down list.	`$.products[*].name`
JSON Path: value	This area determines the parameter which will be stored in the database.	`$.products[*].name` The names of all the products will be shown in the dropdown list of the form and will be stored in the database when the user makes a selection.

Syntax for JSON path starts with a $ sign. You can specify the which data body should be taken into consideration. In our example, it is the product body. [*] means all rows under the product should be included. The last part after . specifies the column name which the data will be derived.

Blank space should be avoided from the column names to reach the information via JSON.