Inicio rápido
Cada solicitud se autentica con una clave de API que creas en la app. Apunta curl, tu CI o cualquier cliente HTTP a https://app.relvato.com/api/v1.
# 1 — Confirm your key works and see the endpoints curl https://app.relvato.com/api/v1 \ -H "Authorization: Bearer rlv_your_key" # 2 — List the sites Relvato monitors for you curl https://app.relvato.com/api/v1/sites \ -H "Authorization: Bearer rlv_your_key" # 3 — Read recent runs (optionally scoped to one site) curl "https://app.relvato.com/api/v1/runs?limit=10" \ -H "Authorization: Bearer rlv_your_key" # 4 — Trigger an on-demand scan of a site curl -X POST https://app.relvato.com/api/v1/sites/SITE_ID/scan \ -H "Authorization: Bearer rlv_your_key"
Autenticación
Envía tu clave en cada solicitud como Authorization: Bearer rlv_your_key (también funciona una cabecera x-api-key). Una clave ausente, revocada o desconocida devuelve 401.
Crea y revoca claves en Acceso a la API dentro de la app. Las claves empiezan por rlv_, se muestran una sola vez al crearse y actúan sobre toda tu cuenta: trátalas como una contraseña.
Endpoints REST
Cada endpoint se limita a la cuenta de la clave y devuelve JSON. URL base https://app.relvato.com/api/v1.
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/v1 | Confirma la clave y lista los endpoints disponibles. |
| GET | /api/v1/sites | Lista los sitios web que Relvato monitoriza para ti. |
| GET | /api/v1/runs | Verificaciones recientes, de más nueva a más antigua — parámetros opcionales siteId y limit (1–100). |
| POST | /api/v1/sites/:id/scan | Encola un escaneo bajo demanda de un sitio. Cuenta para tu cupo mensual de ejecuciones. |
Ejemplo: listar sitios
{
"sites": [
{
"id": "st_1a2b3c",
"name": "style4street",
"url": "https://style4street.com",
"connectionType": "wordpress"
}
]
}Ejemplo: ejecuciones recientes
Una ejecución que falló pero se resolvió después (línea base aceptada o ignorada) informa status: "passed" con resolved: true.
{
"runs": [
{
"id": "rn_9f8e7d",
"siteId": "st_1a2b3c",
"journey": "checkout",
"status": "passed",
"startedAt": "2026-08-31T09:15:00.000Z",
"durationMs": 4210,
"resolved": false
}
]
}Límites de tasa
Las solicitudes se limitan por minuto y por cuenta, sumando REST y MCP. Tu plan fija el máximo:
| Plan | Solicitudes / min |
|---|---|
| Free | 30 |
| Pro | 120 |
| Business | 600 |
| Agency | 2,400 |
Cada respuesta incluye X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset. Al superar el límite se devuelve 429 con una cabecera Retry-After.
Códigos de estado
| Estado | Significado |
|---|---|
200 | Éxito. |
401 | Clave de API ausente, desconocida o revocada. |
404 | Sitio no encontrado para esta cuenta. |
409 | El sitio está desactivado o su dominio aún no está verificado. |
429 | Límite de tasa alcanzado, o cupo mensual de ejecuciones agotado. |
Servidor MCP (para agentes de IA)
Relvato también es un servidor remoto Model Context Protocol, así un agente como Claude puede listar tus sitios, leer ejecuciones y lanzar escaneos en una conversación. Usa la misma clave y el mismo límite que la API REST.
Endpoint https://app.relvato.com/api/mcp
| Herramienta | Qué hace |
|---|---|
list_sites | Lista los sitios que Relvato monitoriza para la cuenta. |
list_runs | Lista ejecuciones recientes, de más nueva a más antigua — opcionalmente de un sitio. |
trigger_scan | Lanza ahora un escaneo bajo demanda de un sitio (respeta el cupo mensual). |
Añádelo como conector HTTP remoto. En un cliente que lee un mcp.json, la entrada es así:
{
"mcpServers": {
"relvato": {
"type": "http",
"url": "https://app.relvato.com/api/mcp",
"headers": {
"Authorization": "Bearer rlv_your_key"
}
}
}
}Preguntas frecuentes
¿Qué planes incluyen acceso a API y MCP?
Todos, incluido Free — solo cambia el límite por minuto. Free permite 30 solicitudes por minuto; los planes de pago, más.
¿Cómo obtengo una clave?
Inicia sesión y abre Acceso a la API en la app. Puedes crear varias claves y revocarlas cuando quieras; cada clave actúa sobre toda tu cuenta.
¿REST y MCP comparten el límite?
Sí. El límite es por cuenta y por minuto, contado sumando ambas interfaces.
¿Lanzar un escaneo consume mi cupo?
Sí. Los escaneos bajo demanda — por REST o MCP — salen del mismo cupo mensual de ejecuciones que las comprobaciones programadas.