Skip to main content

HTTP Source

Overview

The HTTP source allows the platform to periodically query an external API to retrieve data. Unlike the webhook where the external system sends data (push mode), the HTTP source works in pull mode: Ontologie queries the API at regular intervals.

Before you begin

  • Access to a workspace with the Live Data module
  • The URL of an external API that returns JSON data
  • Authentication credentials if the API is protected

How it works

  1. You configure the API URL and test the connection.
  2. You link the source to an entity in your ontology.
  3. Ontologie automatically queries the API at the chosen interval and ingests the new data.

Configuration wizard (2 steps)

From the Live Data catalog, click Configure on the HTTP Source card (Direct Sources section). The wizard unfolds in 2 steps.

Step 1 — Connection

Configure and test the connection to the external API.

FieldDescriptionRequired
Source nameDescriptive name (e.g. Weather API, CRM Clients, Inventory). Minimum 2 characters.Yes
HTTP methodGET (default), POST or PUTYes
URLFull API address (e.g. https://api.example.com/data)Yes

Authentication (optional)

The section is collapsed by default. Expand it if the API requires authentication:

ModeConfiguration
NoneNo authentication (public API)
API KeyHeader name (default: Authorization), prefix (default: Bearer ) and key value. The wizard shows a preview of the final header sent.
BasicUsername and password

Connection test

Click the TEST button to verify that the API responds correctly. The result displays:

ResultInformation displayed
Success (green)HTTP code, response time, number of records detected, field schema
Error (red)Error category, message, suggested recovery action, technical details (expandable)
info

The connection test must succeed before you can proceed to the next step.

Click Next to proceed to step 2.


Step 2 — Activation

Link the source to an entity and configure the synchronization frequency.

Entity linking

Search for and select the target entity in your ontology. Data retrieved from the API will be associated with this entity.

Automatic polling

A toggle allows you to enable or disable automatic polling:

ModeBehavior
Enabled (default)The API is queried automatically at regular intervals
DisabledManual synchronization only (on demand)

If polling is enabled, choose the synchronization interval:

IntervalSyncs / daySyncs / month
15 min~96~2,880
30 min~48~1,440
1 h~24~720
6 h~4~120
24 h1~30

Click Create and activate to finalize the source creation.


Expected result

Your HTTP source is created and active. Data is retrieved automatically according to the configured interval and associated with the target entity. You can track synchronization status in the Monitoring.

Limits

LimitValue
Supported methodsGET, POST, PUT
Request timeout30 seconds
Minimum interval15 minutes
Simultaneous requestsRate limited per workspace

See also