Authentication

Every request needs an API key in the Authorization header:

Authorization: Bearer rmx_your_api_key

Bearer is case-sensitive and is followed by exactly one space.

Create a key

1. Sign in to the panel as the account owner.
2. Open the Developer page and create a key. Give it a name of up to 50 characters.
3. Copy the key right away. It starts with rmx_ and is shown only once.

You can have up to 5 active keys at a time.

Caution

Keep keys on your server. Anyone with a key can spend your wallet balance.

Revoke a key

Revoke a key on the same Developer page. It stops working on the next request. Keys have no expiry date, so revoke a key you no longer use.

When a key is refused

Status	Code	Message	Cause
401	AUTH_ERROR	Missing Authorization header	No Authorization header.
401	AUTH_ERROR	Invalid Authorization header format. Use: Bearer <api_key>	The header does not start with Bearer .
401	AUTH_ERROR	Invalid API key format	The key is not shaped like a Roamex key.
401	AUTH_ERROR	Invalid API key	The key is unknown or revoked, or the account is not active yet.
403	AUTH_ERROR	Your account is suspended. Please contact support.	The account is suspended.
403	AUTH_ERROR	Account is not approved for API access	The account was not approved.

Repeated failed attempts from one IP address are rate limited. See Rate limits.