Quickstart

How to use the Bridgify unified Runtime API.

Concepts

Connector — the integration type (e.g. a webshop or ERP system).
Connection — your configured link to one concrete system using a connector.
Autosync — Bridgify periodically pulls data from the connected system and stores it locally. This makes the Runtime API fast — reads come from the local cache, not from the external system.
Automation — a direct, scheduled sync between two connections. No API key required. Orders, customers and products flow automatically from source to target.
API key — scoped to a single connection; determines tenant + connection + connector automatically. Used to query the Runtime API.

How data stays up-to-date

Bridgify offers two independent ways to keep data in sync. You can use one or both depending on your needs.

Autosync — Runtime API cache

Bridgify pulls resources (orders, customers, products) from your connected system on a schedule and stores them in a local database.

Enables fast, low-latency reads via the Runtime API.
Cadence is configurable per resource (e.g. orders every 5 min, products every 60 min).
Managed per connection under Connections → Details → Resources.

Use this when an external system queries Bridgify to read data via the Runtime API.

Automation — Direct system-to-system sync

An automation links two connections: a source and a target. Bridgify reads from the source and writes directly into the target on a schedule — no API calls from your side needed.

Supported entities: orders, customers, products.
Sync direction is configurable per entity (source → target or target → source).
Managed under Automations in the sidebar.

Use this when you want Bridgify to push data automatically between two connected systems.

Can I use both? Yes. An automation connection does not sync to the local cache by default (the Runtime API cache is off). If you also need API access to the same connection, enable Local storage sync in the connection details. The two modes are independent.

1 — Generate an API key

Open a connection in the Portal and click Generate key in the API keys section. Copy the key immediately — it is only shown once.

You can manage all keys from the API keys page.

2 — Verify your key

Use /api/me to confirm the key resolves correctly.

curl -H "X-API-KEY: YOUR_KEY" \
  https://api.bridgify.be/api/v1/api/me

Returns tenantId, connectionId and connectorKey.

3 — Read resources

All list endpoints support page, pageSize and updatedSince (UTC ISO-8601).

Orders

GET https://api.bridgify.be/api/v1/api/orders?page=1&pageSize=50
GET https://api.bridgify.be/api/v1/api/orders?updatedSince=2026-01-01T00:00:00Z&status=processing,completed
GET https://api.bridgify.be/api/v1/api/orders/{externalId}

Customers

GET https://api.bridgify.be/api/v1/api/customers?page=1&pageSize=50
GET https://api.bridgify.be/api/v1/api/customers?updatedSince=2026-01-01T00:00:00Z

Products

GET https://api.bridgify.be/api/v1/api/products?page=1&pageSize=50
GET https://api.bridgify.be/api/v1/api/products/{externalId}

Product variations

GET https://api.bridgify.be/api/v1/api/products/{productExternalId}/variations?page=1&pageSize=50

4 — Write-back (ERP → shop)

Push updates back to the shop. Requires the connector to support the corresponding write capability.

Order status

POST https://api.bridgify.be/api/v1/api/orders/{externalId}/status
Content-Type: application/json

{ "status": "completed" }

Order tracking

POST https://api.bridgify.be/api/v1/api/orders/{externalId}/tracking
Content-Type: application/json

{
  "trackingNumber": "BE123456789",
  "trackingProvider": "bpost",
  "trackingUrl": "https://track.example.com/BE123456789"
}

Product stock & price

POST https://api.bridgify.be/api/v1/api/products/{externalId}/stock
{ "stockQuantity": 42 }

POST https://api.bridgify.be/api/v1/api/products/{externalId}/price
{ "price": 19.99 }

Variation stock & price

POST https://api.bridgify.be/api/v1/api/products/{productId}/variations/{variationId}/stock
{ "stockQuantity": 10 }

POST https://api.bridgify.be/api/v1/api/products/{productId}/variations/{variationId}/price
{ "price": 9.99 }

5 — Paging pattern

Start with page=1 and keep paging until hasMore=false.
Store the latest modifiedAt timestamp per resource.
Next run: pass it as updatedSince to fetch only changes.

6 — Capabilities & health

Check what the connector behind your key supports before calling write endpoints.

GET https://api.bridgify.be/api/v1/api/capabilities

Verify the underlying connection is reachable:

GET https://api.bridgify.be/api/v1/api/health/connection