Saltar al contenido
es

API: primeros pasos para integradores

Cómo autenticarte con una clave de API, qué permisos (scopes) pedir, los límites de peticiones y las convenciones de la API REST.

Actualizado el 25 de septiembre de 2026

Documentación de referencia

La referencia completa e interactiva de la API (OpenAPI 3.1) está en el portal de desarrolladores. La API se llama en /api/v1 del dominio de la web (por ejemplo, https://roamdia.com/api/v1/public/currencies).

Autenticación

  1. Un administrador de tu organización crea una clave de API en Canal → Integraciones, con los permisos (scopes) que necesitas: por ejemplo catalog.read y booking.create.
  2. Envía la clave en cada petición:
GET /public/currencies
Authorization: Bearer rmd_...

El secreto solo se muestra al crearla y se puede revocar al momento. Una clave nunca concede más de lo que tiene quien la crea.

Límites

Cada clave tiene un límite por minuto (600 por omisión). Las respuestas llevan x-ratelimit-limit, x-ratelimit-remaining y x-ratelimit-reset; al superarlo recibes 429 con retry-after.

Convenciones

  • Importes en unidades menores con su moneda: {"amount": 2500, "currency": "EUR"} son 25,00 €.
  • Errores: {"error": {"code": "...", "message": "...", "requestId": "..."}}. Programa contra code; message sale en español o inglés según Accept-Language.
  • Listados paginados por cursor con limit y before.

Siguientes pasos