Skip to main content

​
Overview

The API connector connects to an HTTP API or an OData service. It does not copy and store your data — it calls the API live at query time.
This screen is available to Manager and above (owner, manager) only. Menu visibility manage.

​
Steps

1

Request · paging

Configure the request to call and the paging method.
2

Response · drill

Test the call and drill into the response to locate the data.
3

Data view · filter

Review the preview and add filters so only matching rows are used.
4

Field mapping

For each column, set a Meaning (required, standard field name) and Detail (optional).
5

Register

Enter a name and register the data source.

​
HTTP API

REQUEST fields are all optional — you can call with just the URL.

​
OData

1

Enter service URL

Enter the OData service root URL.
2

Connect & list entity sets

Connect, then select an entity set. The method is fixed to GET, and cursor paging is the default.

​
Paging

​
Response handling

After a test call, set the response type: Auto-detect / JSON / CSV / Excel. For JSON responses, drill into the location to select the data.

​
Security

Credentials such as headers and body are encrypted with AES-256-GCM and are never returned to the client. When editing, leaving a field blank keeps the stored value.
Calls to internal or private addresses are not allowed.