Démarrage rapide
Chaque requête s'authentifie avec une clé d'API que vous créez dans l'app. Pointez curl, votre CI ou n'importe quel client HTTP vers 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"
Authentification
Envoyez votre clé à chaque requête via Authorization: Bearer rlv_your_key (un en-tête x-api-key fonctionne aussi). Une clé manquante, révoquée ou inconnue renvoie 401.
Créez et révoquez des clés sous Accès API dans l'app. Les clés commencent par rlv_, s'affichent une seule fois à la création et agissent sur tout votre compte — traitez-les comme un mot de passe.
Endpoints REST
Chaque endpoint est limité au compte de la clé et renvoie du JSON. URL de base https://app.relvato.com/api/v1.
| Méthode | Endpoint | Description |
|---|---|---|
| GET | /api/v1 | Confirme la clé et liste les endpoints disponibles. |
| GET | /api/v1/sites | Liste les sites que Relvato surveille pour vous. |
| GET | /api/v1/runs | Vérifications récentes, de la plus récente à la plus ancienne — paramètres optionnels siteId et limit (1–100). |
| POST | /api/v1/sites/:id/scan | Met en file un scan à la demande d'un site. Compté sur votre quota mensuel d'exécutions. |
Exemple : lister les sites
{
"sites": [
{
"id": "st_1a2b3c",
"name": "style4street",
"url": "https://style4street.com",
"connectionType": "wordpress"
}
]
}Exemple : exécutions récentes
Une exécution en échec puis résolue (référence acceptée ou ignorée) renvoie status: "passed" avec resolved: true.
{
"runs": [
{
"id": "rn_9f8e7d",
"siteId": "st_1a2b3c",
"journey": "checkout",
"status": "passed",
"startedAt": "2026-08-31T09:15:00.000Z",
"durationMs": 4210,
"resolved": false
}
]
}Limites de débit
Les requêtes sont limitées par minute et par compte, REST et MCP confondus. Votre forfait fixe le plafond :
| Forfait | Requêtes / min |
|---|---|
| Free | 30 |
| Pro | 120 |
| Business | 600 |
| Agency | 2,400 |
Chaque réponse porte X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset. Au-delà de la limite, 429 est renvoyé avec un en-tête Retry-After.
Codes de statut
| Statut | Signification |
|---|---|
200 | Succès. |
401 | Clé d'API manquante, inconnue ou révoquée. |
404 | Site introuvable pour ce compte. |
409 | Le site est désactivé ou son domaine n'est pas encore vérifié. |
429 | Limite de débit atteinte, ou quota mensuel d'exécutions épuisé. |
Serveur MCP (pour agents IA)
Relvato est aussi un serveur Model Context Protocol distant : un agent comme Claude peut lister vos sites, lire les exécutions et lancer des scans dans une conversation. Il utilise la même clé et la même limite que l'API REST.
Endpoint https://app.relvato.com/api/mcp
| Outil | Rôle |
|---|---|
list_sites | Liste les sites que Relvato surveille pour le compte. |
list_runs | Liste les exécutions récentes, de la plus récente à la plus ancienne — au besoin pour un seul site. |
trigger_scan | Lance maintenant un scan à la demande d'un site (respecte le quota mensuel). |
Ajoutez-le comme connecteur HTTP distant. Dans un client qui lit un mcp.json, l'entrée ressemble à ceci :
{
"mcpServers": {
"relvato": {
"type": "http",
"url": "https://app.relvato.com/api/mcp",
"headers": {
"Authorization": "Bearer rlv_your_key"
}
}
}
}Questions fréquentes
Quels forfaits incluent l'accès API et MCP ?
Tous, y compris Free — seule la limite par minute change. Free autorise 30 requêtes par minute ; les forfaits payants davantage.
Comment obtenir une clé ?
Connectez-vous et ouvrez Accès API dans l'app. Vous pouvez créer plusieurs clés et les révoquer à tout moment ; chaque clé agit sur tout votre compte.
REST et MCP partagent-ils la limite ?
Oui. La limite est par compte et par minute, comptée sur les deux interfaces réunies.
Lancer un scan consomme-t-il mon quota ?
Oui. Les scans à la demande — via REST ou MCP — puisent dans le même quota mensuel d'exécutions que les vérifications planifiées.