Sync API basics

Updated July 11, 2026Available from the Starter plan

If you prefer content stored inside your eshop (rather than served by the widget), your developer pulls it with the Sync API — a simple REST API with a two-step flow.

The model: pending → confirm

Every product, category and brand has a sync state with only two values:

  • pending_sync — there's an approved change not yet pulled.
  • synced — your eshop has the latest version.

Every new approval flips the item back to pending_sync. The developer flow:

  1. Pull what's pending: GET /api/v1/sync/products/pending — returns only what changed.
  2. Store the data in the eshop's database.
  3. Confirm: POST /api/v1/sync/products/confirm with the stored IDs — they're marked synced.

The same flow applies to categories and brands. GET /api/v1/sync/status gives the overall picture (pending counts per type).

Authentication

All requests need an API key as a Bearer token:

curl -H "Authorization: Bearer ac_xxxxxxxx" \
  https://aironflow.io/api/v1/sync/products/pending

Keys (prefix ac_) are created in your account settings. Limit: 100 requests/minute.

The API key grants access to your eshop's data — treat it like a password. If it leaks, revoke it and create a new one.

Getting notified of new data

Instead of polling, register a webhook: when a sync completes with new content, AironFlow calls your URL (data_ready) and you pull the pending items then.

The full reference with every endpoint, parameter and example: Integration Guide. A ready-made Postman collection is downloadable from your account's integration page.

Was this article helpful?

Previous
Embedding the widget in your store

Related articles