Academy
Data Sources

API Rest Stage

The API Rest stage imports data from any system that provides a REST API — the JSON response is automatically converted into tabular columns for use in the flow. Use it when the system does not have a native connector on the platform, or when the data you need is not in the connector reports. The API Rest is in the Data Source category of the toolbar.

How to configure

The configuration is organized into four tabs.

API Tab

  • Name: identifies the stage in the flow.

  • HTTP Method: GET or POST, depending on the API being queried.

  • Endpoint URL: API address.

  • Has pagination: enable this when the API splits the response into pages — the platform automatically goes through the pages (by page number or offset, depending on the API).

  • URL Variables: dynamic request parameters, including values calculated from the execution's reference date.

  • Authorization Options: enables authentication — supported methods include username and password (Basic), token (Bearer), HTTP signature and AWS signature, as well as an authentication route (a prior request that obtains the token used in subsequent calls).

Header Tab

  • Header Variables: additional HTTP headers required by the API (e.g., Content-Type).

Body Tab

  • Request body, for POST methods.

Return Tab

  • Execute Connection: tests the request directly from the editor and shows the status, time, and response size.

  • Structure Browser: the returned JSON appears as a tree — select the fields you want to import.

  • Column Mapping: for each selected field, define the column name and data type (alphanumeric, numeric, or date).

Usage example

A company needs the daily dollar exchange rate to convert balances. In the API Rest stage, it enters the currency exchange API URL with a date variable filled in by the reference date, tests the connection in the Return tab, selects the date and purchase value fields in the JSON tree, and names the columns. With each run, the day's exchange rate enters the flow and can be crossed with other sources using a Search stage.

Warning — data volume: API integration is not recommended for volumes above 500 thousand records per execution, as it may cause slowness and failures. For large volumes, prefer the Database stage or file exchange.

  • Custom integrations via API Rest and SQL connectors

  • Database Stage

  • ERP Stage

Was this helpful?
Was this helpful?