Getting started

The FactoraERP API gives your systems read-only access to one factory's customers, inventory items and sales invoices, plus signed webhooks for key events.

API v1 is read-only. Webhook delivery is currently in dry-run mode: events are signed and logged but not sent.

Base URL

Status	URL
Current	`https://brazen-raven-302.convex.site`
Coming soon	`https://api.factoraerp.com`

Quick start

A factory admin (Admin, CEO/Director or General Manager role) opens System Settings → API access in FactoraERP.
They create a key, choose its scopes and expiry, and copy it. The key starts with fxk_ and is shown only once.
Call the API with the key in a header:

curl -H "Authorization: Bearer $FACTORA_API_KEY" https://brazen-raven-302.convex.site/api/v1/me

{"ok":true,"organizationId":"<factory id>","scopes":["read:customers","read:sales"]}

What's available

Endpoint	Scope
`GET /api/v1/me`	any valid key
`GET /api/v1/customers`	`read:customers`
`GET /api/v1/inventory-items`	`read:inventory`
`GET /api/v1/sales-invoices`	`read:sales`

The API is designed for server-to-server use. It sends no CORS headers, so browsers will block calls from web pages. Keep keys on your server.