API publique

L'API publique offre un accès en lecture seule aux données que RankMeFast détient déjà pour votre compte — sites, dernier rapport d'audit, historique des positions et mots-clés suivis. C'est une fonction Agency (voir Plans, limites et crédits). L'API ne déclenche jamais de nouveau travail fournisseur — elle lit uniquement ce que vos audits et vérifications de position ont déjà produit.

Authentification

Créez une clé dans Compte → Clés API (/profile?tab=api-keys). La clé complète n'est affichée qu'une seule fois — copiez-la immédiatement ; ensuite seul son préfixe reste visible. Vous pouvez détenir jusqu'à dix clés actives et en révoquer à tout moment. Une clé révoquée cesse de fonctionner immédiatement.

Envoyez la clé comme jeton bearer sur chaque requête :

Authorization: Bearer rmf_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Remplacez https://your-rankme-host dans les exemples ci-dessous par l'origine de votre api (le SERVER_URL de votre installation).

Points d'accès

Lister vos sites

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/sites

Renvoie { "sites": [{ "id", "domain", "url", "createdAt" }] }.

Dernier rapport d'audit d'un site

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/sites/<siteId>/report/latest

Renvoie l'audit réussi le plus récent sous la forme { "runId", "report" } — les mêmes constats, catégories et textes localisés que le tableau de bord. Répond 404 si le site n'a pas encore d'audit terminé.

Historique des positions d'un site

curl -H "Authorization: Bearer rmf_..." \
  "https://your-rankme-host/api/v1/sites/<siteId>/rank-history?from=2026-06-01&to=2026-07-01"

Renvoie { "keywords": [{ "id", "phrase", "series": [...] }] }. Chaque point porte la position, l'URL classée et les signaux Google AI Overview (aiOverviewPresent, aiCited, aiCitedUrl). from et to sont des dates ISO facultatives.

Tous les mots-clés suivis

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/keywords

Renvoie chaque mot-clé suivi sur l'ensemble de vos sites avec sa dernière position, son delta et les champs AI Overview.

Compatibilité

Cette version expose exactement quatre routes en lecture seule :

• GET /api/v1/sites
• GET /api/v1/sites/:siteId/report/latest
• GET /api/v1/sites/:siteId/rank-history
• GET /api/v1/keywords

Le Radar de marque, l’Intelligence des avis, l’Intelligence des liens, l’Analyse du trafic, les Tendances de mots-clés et le Capteur SERP n’ajoutent aucune route sous /api/v1. Les cinq fonctions payantes restent dans le tableau de bord authentifié ; le capteur public reste sous /api/volatility. Les champs existants conservent leur sens et les clients doivent ignorer les champs additifs qu’ils ne reconnaissent pas.

<!-- public-api-routes: GET /api/v1/sites; GET /api/v1/sites/:siteId/report/latest; GET /api/v1/sites/:siteId/rank-history; GET /api/v1/keywords -->

Limites de débit

Par défaut, chaque clé peut effectuer 120 requêtes par minute. Au-delà, l'API répond 429 jusqu'à la réinitialisation de la fenêtre.

Erreurs

Les erreurs utilisent la forme { "error": { "message": "...", "details": ... } }, localisée selon votre en-tête Accept-Language :

• 401 — la clé est absente, malformée, révoquée ou inconnue.
• 402 — votre plan n'inclut pas l'API.
• 404 — le site ou le rapport n'existe pas sur votre compte.
• 429 — limite de débit dépassée (corps : { "error": "..." }).

Retour à l'index de la documentation