APIs & webhooks
Integrate without writing an app
Your ERP integrator needs orders out and stock in. Your BI team wants a nightly export. Your customer's IT wants a punchout endpoint. None of them are building an app, and none of them should need to read the Developer Portal to get an API key. This area is the Customer-side of the platform's interfaces: what exists, how to get access safely, and where the boundary to real development sits.
Understand
- The platform's interfaces, in one map — REST API, webhooks, bulk import/export, punchout, SFTP — which one for which job.
- Keys, scopes and tenants — How access works, and how to give an integrator exactly enough.
- The sandbox — A tenant you can break.
- Rate limits, quotas and fair use — What happens at 429, and how to design around it.
Set up
- Create an API key — Settings › API keys, scoped and named.
- Set up webhooks — Subscribe your system to events.
- SFTP and file exchange — For the ERP that only speaks CSV.
- Set up a sandbox — Provision, seed, hand to the integrator.
Work with it
- Common API tasks, by job — Orders out, stock in, prices in, customers in — the recipes.
- Bulk exports — Everything, nightly, for BI.
- Test an integration end to end — Sandbox, fixtures, the checklist.
Keep it healthy
- Monitor your integrations — Calls, errors, latency, webhook delivery.
- Common API problems — 401, 403, 429, 422 — and the webhook that never arrives.
- Handling API changes — Deprecations, versions, the changelog.
Where this connects
- Integration patterns — batch, real-time or hybrid, before you choose an interface.
- Deciding your system of record — which system may write which field.
- Events and webhooks — the operator view of subscriptions and retries.
- Punchout explained — the fifth interface, covered in full over there.
- Connect your ERP — the wider project this sits inside.
- Cut manual work — what the integration is actually for.