Разработчикам

Публичный API

Читайте свои сайты, отчёты, позиции и ключевые слова через простой API с ключевой аутентификацией. Функция Agency.

Публичный API

Публичный API даёт доступ только для чтения к данным, которые RankMeFast уже хранит для вашего аккаунта — сайты, последний отчёт аудита, история позиций и отслеживаемые ключевые слова. Это функция плана Agency (см. Планы, лимиты и кредиты). API никогда не запускает новую работу поставщиков — он лишь читает то, что уже произвели ваши аудиты и проверки позиций.

Аутентификация

Создайте ключ в разделе Аккаунт → API-ключи (/profile?tab=api-keys). Полный ключ показывается только один раз — сразу скопируйте его; после этого виден лишь его префикс. Можно держать до десяти активных ключей и отзывать любой в любой момент. Отозванный ключ перестаёт работать немедленно.

Передавайте ключ как bearer-токен в каждом запросе:

Authorization: Bearer rmf_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Замените https://your-rankme-host в примерах ниже на origin вашего api (значение SERVER_URL вашей установки).

Конечные точки

Список ваших сайтов

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

Возвращает { "sites": [{ "id", "domain", "url", "createdAt" }] }.

Последний отчёт аудита сайта

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

Возвращает самый свежий успешный аудит в виде { "runId", "report" } — те же находки, категории и локализованные тексты, что и в панели. Отвечает 404, если у сайта ещё нет завершённого аудита.

История позиций сайта

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

Возвращает { "keywords": [{ "id", "phrase", "series": [...] }] }. Каждая точка серии содержит позицию, ранжировавшийся URL и сигналы Google AI Overview (aiOverviewPresent, aiCited, aiCitedUrl). from и to — необязательные даты ISO.

Все отслеживаемые ключевые слова

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

Возвращает каждое отслеживаемое ключевое слово по всем вашим сайтам с последней позицией, дельтой и полями AI Overview.

Лимиты запросов

По умолчанию каждый ключ может делать 120 запросов в минуту. Сверх этого API отвечает 429 до сброса окна.

Ошибки

Ошибки имеют форму { "error": { "message": "...", "details": ... } } и локализуются по заголовку Accept-Language:

401 — ключ отсутствует, повреждён, отозван или неизвестен.
402 — ваш план не включает API.
404 — сайт или отчёт не существует в вашем аккаунте.
429 — превышен лимит запросов (тело: { "error": "..." }).

Совместимость

В этом выпуске доступны ровно четыре маршрута только для чтения:

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

«Радар бренда», «Аналитика отзывов», «Аналитика ссылок», «Данные о трафике», «Тренды ключевых слов» и датчик SERP не добавляют маршрутов в /api/v1. Пять платных функций остаются в панели с аутентификацией; публичный датчик остаётся в /api/volatility. Смысл существующих полей ответа не меняется. Клиенты должны игнорировать незнакомые дополнительные поля.

Назад к оглавлению документации