Omnix Public API

Programmatic access to your Omnix account. Read your machines, licenses, and product data from Zapier, Make, or your own scripts.

Base URL

https://omnix.co.ke/api/public/v1

Authentication

All requests need an X-Omnix-Api-Key header (or an Authorization: Bearer <key> header — both work). API keys are issued per account on request — contact Omnix support to get yours.

curl https://omnix.co.ke/api/public/v1/health \
  -H 'X-Omnix-Api-Key: YOUR_KEY_HERE'

Rate limits

100 requests per minute per key. Exceeding returns HTTP 429 with a Retry-After header.

Scopes

Each API key is scoped. Available scopes:

read:machines — list machines
read:licenses — list licenses
* — everything above (owner-only, use with care)

Endpoints

Method	Path	Scope	Description
`GET`	`/api/public/v1/health`	`(none)`	Confirm your API key works. Returns owner id + granted scopes.
`GET`	`/api/public/v1/machines`	`read:machines`	List every machine registered under your account.
`GET`	`/api/public/v1/licenses`	`read:licenses`	List every license you own with current variant + status.

Versioning

The current version is v1. Breaking changes ship under new version prefixes (v2, etc.). We keep the previous version alive for at least 6 months after a new version launches.

Coming soon

read:products — product catalog
read:customers — customer list
read:sales — sales history
read:inventory — stock levels + valuation
Webhooks for sale events, licence changes, telemetry updates