Quickstart

How to call Bridgify runtime endpoints using a connection API key.

Concepts

Connector = the integration type (e.g. WooCommerce).
Connection = your configured link to one concrete system (your webshop/ERP environment).
API key = scoped to a single connection; it determines tenant + connection + connector automatically.

1) Create a connection & grab its API key

Create a connection in the Portal. The API key is shown once during creation—store it securely. You can manage keys afterwards on the API keys page.

2) Verify your key (who am I?)

Use /api/me to confirm the runtime context resolved by the API key.

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

Expected: you’ll see tenantId, connectionId and connectorKey in the response.

3) Call the unified runtime endpoints

Example request (products). Replace placeholders with your values.

curl -H "X-API-KEY: YOUR_CONNECTION_API_KEY" \
  "https://api.bridgify.be/api/products?page=1&pageSize=10"

Tip: add updatedSince (UTC) for incremental sync, e.g. &updatedSince=2026-02-01T00:00:00Z.

4) More resources

Customers and orders work the same way. Orders optionally supports a comma-separated status filter.

# Customers
curl -H "X-API-KEY: YOUR_CONNECTION_API_KEY" \
  "https://api.bridgify.be/api/customers?page=1&pageSize=50&updatedSince=2026-02-01T00:00:00Z"

# Orders (optional status filter)
curl -H "X-API-KEY: YOUR_CONNECTION_API_KEY" \
  "https://api.bridgify.be/api/orders?page=1&pageSize=50&updatedSince=2026-02-01T00:00:00Z&status=processing,completed"

5) Sync pattern

Start with page=1 and keep paging until the response indicates there are no more items (e.g. hasMore=false).
Persist the latest modified timestamp you received (per resource).
Next run, pass it as updatedSince (UTC).
If your connector has capability restrictions, check /api/capabilities first.

Capabilities (resolved from the connector behind your API key):

curl -H "X-API-KEY: YOUR_CONNECTION_API_KEY" \
  "https://api.bridgify.be/api/capabilities"