> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oxanaut.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Authentication

> Authenticating against the Oxanaut API: personal API keys and permissions.

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.

```bash Authorization theme={null}
Authorization: Bearer oxn_your_key
```

```bash Example theme={null}
curl https://api.oxanaut.com/v1/services \
  -H "Authorization: Bearer oxn_your_key"
```

## Permissions

| Permission   | Access                                               |
| ------------ | ---------------------------------------------------- |
| `read`       | `GET`/`HEAD` requests only. Any write returns `403`. |
| `read-write` | Every route allowed for your account.                |

The permission is enforced server-side on every request; a `read` key can never modify a resource.

<Warning>
  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.
</Warning>

## 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](/api-reference/get-v1-services) 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 started](/en/panel/getting-started.md)
- [Rate limits](/en/api/rate-limits.md)
- [Integrations](/en/panel/integrations.md)
- [Oxanaut documentation](/en/index.md)