API pública

Desarrolladores

API pública

Lee tus sitios, informes, posiciones y palabras clave mediante una API sencilla autenticada con clave. Función Agency.

API pública

La API pública ofrece acceso de solo lectura a los datos que RankMeFast ya guarda de tu cuenta — sitios, el último informe de auditoría, el historial de posiciones y las palabras clave seguidas. Es una función Agency (consulta Planes, límites y créditos). La API nunca genera trabajo nuevo con proveedores — solo lee lo que tus auditorías y comprobaciones de posición ya han producido.

Autenticación

Crea una clave en Cuenta → Claves de API (/profile?tab=api-keys). La clave completa se muestra exactamente una vez — cópiala de inmediato; después solo será visible su prefijo. Puedes tener hasta diez claves activas y revocar cualquiera en cualquier momento. Una clave revocada deja de funcionar de inmediato.

Envía la clave como token bearer en cada solicitud:

Authorization: Bearer rmf_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Sustituye https://your-rankme-host en los ejemplos por el origen de tu api (el SERVER_URL de tu instalación).

Puntos de acceso

Listar tus sitios

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

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

Último informe de auditoría de un sitio

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

Devuelve la auditoría completada más reciente como { "runId", "report" } — los mismos hallazgos, categorías y textos localizados que muestra el panel. Responde 404 si el sitio aún no tiene una auditoría terminada.

Historial de posiciones de un sitio

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

Devuelve { "keywords": [{ "id", "phrase", "series": [...] }] }. Cada punto incluye la posición, la URL que posicionó y las señales de Google AI Overview (aiOverviewPresent, aiCited, aiCitedUrl). from y to son fechas ISO opcionales.

Todas las palabras clave seguidas

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

Devuelve cada palabra clave seguida en todos tus sitios con su última posición, delta y los campos de AI Overview.

Límites de uso

Por defecto, cada clave puede hacer 120 solicitudes por minuto. Por encima de eso la API responde 429 hasta que se reinicia la ventana.

Errores

Los errores usan la forma { "error": { "message": "...", "details": ... } }, localizada según tu cabecera Accept-Language:

  • 401 — la clave falta, está mal formada, revocada o es desconocida.
  • 402 — tu plan no incluye la API.
  • 404 — el sitio o el informe no existe en tu cuenta.
  • 429 — límite de uso superado (cuerpo: { "error": "..." }).

Compatibilidad

Esta versión expone exactamente cuatro rutas de solo lectura:

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

Radar de marca, Inteligencia de reseñas, Inteligencia de enlaces, Información de tráfico, Tendencias de palabras clave y el Sensor SERP no añaden rutas bajo /api/v1. Las cinco funciones de pago siguen en el panel autenticado; el sensor público sigue bajo /api/volatility. Los campos existentes conservan su significado y los clientes deben ignorar los campos adicionales que no reconozcan.

<!-- 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 -->

Volver al índice de la documentación