Saltar al contenido

Referencia de la API

Referencia de la API de Vemudo generada del contrato OpenAPI: autenticación, convenciones y cada operación con su ruta, scope, parámetros, respuestas y ejemplo curl.

Antes de empezar

Esta referencia se genera a partir del contrato OpenAPI de la API y muestra cada operación con su método, ruta, permiso necesario, parámetros, cuerpo, respuestas y un ejemplo con curl. Para entender los conceptos, empieza por las guías.

Autenticación

Todas las peticiones llevan una clave de API en la cabecera Authorization. La URL base es https://api.vemudo.com.

bash
curl https://api.vemudo.com/v1/me \
  -H "Authorization: Bearer $VEMUDO_API_KEY"

La clave tiene un entorno (test o live) y un scope (send, read o full; full incluye los otros dos). Si falta el permiso, la API responde 403 insufficient_scope. Detalles en Autenticación y claves.

Convenciones

  • JSON en camelCase, fechas en ISO 8601 UTC y estados en minúsculas.
  • Los listados devuelven { "data": [], "nextCursor": "..." }; limit va de 1 a 100 y cursor es opaco.
  • Los errores usan application/problem+json con un code estable. Ver Errores y límites.
  • Límite general: 10 peticiones por segundo por organización.

Operaciones por sección