Skip to main content
The Oxanaut API is served from https://api.oxanaut.com. All routes are prefixed with /v1.

​
API keys

Create a key from the panel: Integrations → Oxanaut API → Enable / Configure. The key starts with oxn_ and is displayed only once at creation.
Authorization
Example

​
Permissions

The permission is enforced server-side on every request; a read key can never modify a resource.
An API key grants access to your account data just like a session. Name each key after its use, give it an expiry date when possible, and revoke unused keys.

​
Conventions

  • Format: JSON on every route (Content-Type: application/json).
  • Errors: simplified RFC 7807 - statusCode, message, sometimes error.
  • Dates: ISO 8601 (UTC).
  • Amounts: in cents (totalCents: 363 = €3.63).

​
Route scope

The API reference documents every route by domain: account, services, billing, store and cart, integrations, notifications, affiliation, status. The /v1/admin/* and /v1/bot/* routes require server-side rights or a bot token and are grouped at the end of the reference.

Related topics

Getting startedRate limitsIntegrationsOxanaut documentation