Getting started

Two kinds of key

  • A platform key is for a product that serves many businesses, such as a point of sale, a payments service or a payroll service. It does nothing on its own: each business you serve approves a connection first, and every call names the business in the Vortex-Entity header. Register your platform on Your platforms (sign in to SYNC first) and you get a test key at once.
  • A business’s own key is for one business’s own scripts and tools. Its owner makes it on the API keys page inside SYNC (on the Pro plan), and it needs no Vortex-Entity header.

Test mode, then live

A new platform is in test mode. Its keys start with vs_test_, and it can only connect businesses owned by people on its own team: make a test business in SYNC and connect it to try everything. When you’re ready, an owner asks Vortex to approve the platform for live on its page. Once approved it can make live keys (vs_live_) and connect any business, whose owner approves each connection as always. A key is shown once, when it’s made; keep it on your server, never in a browser or an app. Questions: support@vortexsync.ai.

Making a call

Send the key as a bearer token, and every POST with an Idempotency-Key you choose (up to 255 characters):

curl https://api.vortexsync.ai/v1/connections \
  -H "Authorization: Bearer vs_live_..."

curl https://api.vortexsync.ai/v1/events/sales \
  -H "Authorization: Bearer vs_live_..." \
  -H "Vortex-Entity: 6f1c...e2" \
  -H "Idempotency-Key: sale-1042" \
  -H "Content-Type: application/json" \
  -d '{"external_id": "sale-1042", "occurred_on": "2026-11-13", ...}'

Retries are safe

Sending the same Idempotency-Key with the same body returns the first answer and does nothing new; the same key with a different body is refused with idempotency_conflict. Events also carry your own external_id, unique for each connection: posting one twice is refused with duplicate_external_id. Retry timeouts and 5xx answers with the same key; don’t retry a 4xx unchanged.

Limits

A platform key can make 120 requests a minute for each business it acts for, and a business’s own key 60 a minute. Past that the answer is 429 rate_limited. A business’s own keys also share an allowance of 100,000 requests a month: its owners are emailed as it’s reached, and requests keep working up to 200,000, then answer 429 monthly_limit_reached until the next month. Both send Retry-After. The rate_limited answer, and answers to requests that pass the limit checks, carry RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset.

Conventions

  • Money is a decimal string with up to four decimal places, such as "1250.00".
  • Business dates are YYYY-MM-DD; timestamps are UTC.
  • Lists take limit (1 to 100) and starting_after (an id) and say has_more.
  • Posted entries are never edited or deleted: a correction is a reversal.
  • The version is in the path. A breaking change comes as a new version, with at least 12 months’ notice.

Next: connect a business.