انتقل إلى المحتوى
ar

API: getting started for integrators

How to authenticate with an API key, which permissions (scopes) to request, rate limits and the conventions of the REST API.

تم التحديث في 25 سبتمبر 2026

هذا الوصف غير مترجم بعد: يُعرض باللغة الإنجليزية.

Reference documentation

The complete, interactive API reference (OpenAPI 3.1) is in the developer portal. The API is served under /api/v1 on the website domain (for example, https://roamdia.com/api/v1/public/currencies).

Authentication

  1. An administrator of your organisation creates an API key under Channel → Integrations, with the permissions (scopes) you need: for example catalog.read and booking.create.
  2. Send the key with every request:
GET /public/currencies
Authorization: Bearer rmd_...

The secret is only shown when the key is created and can be revoked instantly. A key never grants more than its creator has.

Limits

Each key has a per-minute limit (600 by default). Responses carry x-ratelimit-limit, x-ratelimit-remaining and x-ratelimit-reset; when you exceed it you get 429 with retry-after.

Conventions

  • Amounts in minor units with their currency: {"amount": 2500, "currency": "EUR"} is €25.00.
  • Errors: {"error": {"code": "...", "message": "...", "requestId": "..."}}. Code against code; message comes in Spanish or English depending on Accept-Language.
  • Lists use cursor pagination with limit and before.

Next steps