Information
- OpenAPI version:
3.1.0
Overview
Buy, deliver and manage eSIMs from your Roamex balance.
Roamex API 1
Section titled “Roamex API 1”The Roamex API lets your own systems read the eSIM catalogue at your prices, buy eSIMs from your Roamex balance, top them up, email them to travellers and follow what happens to them.
Requests. Every endpoint is a POST. Send a JSON body where the endpoint takes one. Bodies
larger than 100 KB (by Content-Length) are refused with 413 PAYLOAD_TOO_LARGE.
Responses. A success is a JSON object with success: true beside its fields. A failure is
{"success": false, "error": {"code": "...", "message": "..."}}. Branch on error.code: some
codes are returned with more than one HTTP status, and some statuses carry several codes.
Money is an object with amount in euro cents, currency (EUR) and a formatted string
such as €12.50. Data sizes are an object with bytes and a formatted string.
Rate limits are per account and per minute, counted per group of endpoints: /esims/purchase
20, /esims/topup 30, /esims/cancel 30, /esims/fulfill 60, /plans and /regions 30
together, /balance 100, and 100 shared by every other endpoint. Refused keys are throttled
separately: 10 a minute per IP address and key prefix, and 60 per 15 minutes per IP address.
Switched off. While the API is not enabled on the platform, every endpoint answers
404 NOT_FOUND with the message This feature is not available., before the key is checked.
Authentication
Section titled “Authentication”apiKey
Section titled “apiKey”Send your API key as Authorization: Bearer <key>, with Bearer written exactly like that. The account owner creates and revokes keys on the Developer page of the panel. An account can hold 5 active keys, and a revoked key stops working on its next request. A key acts for the whole account and does not expire.
Security scheme type: http
Bearer format: rmx_ followed by 64 lowercase hexadecimal characters