Nexym support
Overview
Read/write JSON API over the Nexym hub's universal entities.
Nexym API 1.0.0
Section titled “Nexym API 1.0.0”The Nexym hub normalises business data from any connected system into one universal schema. This API is how an external consumer reads that data back out, and how it writes a small set of records into it.
Every endpoint lives under the path prefix /api/connect.
Scope. A key is issued for exactly one project (tenant) and carries per-resource abilities. Everything this API returns is scoped to that project — there is no project parameter, and no way to reach past it.
Ask for JSON. Send Accept: application/json on every request. These routes are
not in Laravel’s api middleware group, so a client that does not ask for JSON gets
an HTML error page on a 403/404 and a 302 redirect instead of a 422 when a write
payload fails validation.
Shape. Every list endpoint returns a page of records in the framework’s standard
pagination envelope (data plus current_page, total, next_page_url, …). The
knobs are per_page, page, cursor (or paginate=cursor) and updated_since —
records changed at or after that moment, given as an ISO 8601 date or time; a time
with an offset (2026-09-01T00:00:00Z, …+02:00) means that instant. No other
filtering or sorting is implemented. Times are returned as ISO 8601 in UTC (…Z).
Money and quantity columns are fixed-precision decimals and are serialised as
strings ("1299.00"), not numbers.
Extension and customer fields. A field one connector or one customer needs that
the universal schema does not define for everybody is carried in the record’s meta
object under its own name. Read it there.
Authentication
Section titled “Authentication”bearerAuth
Section titled “bearerAuth”A project API key, sent as Authorization: Bearer ck_…. Keys are minted in the
dashboard, start with ck_, and the secret is shown once — only a hash is
stored, so a lost key is replaced rather than recovered.
Abilities. A key carries a {resource: read|write} map over the ten
resources this API exposes: products, stock, orders, invoices, quotes,
returns, shipments, checkouts, subscribers, customers. A list endpoint
needs read on its resource; a write endpoint needs write. write implies
read. A resource the key’s map does not mention is not accessible at all — a
key with no abilities set can reach nothing.
Lifetime. A key may be given an expiry and may be revoked; either makes every
request fail with 401. Each accepted request bumps the key’s last-used stamp
and its request counters.
Security scheme type: http