RoomSEOSEO-аудит сайтов

RoomSEO API

Интеграции

Запускайте и контролируйте аудиты из CRM, внутренних панелей и автоматических сценариев.

API-ключи Статус

Авторизация

Передавайте ключ в заголовке Authorization: Bearer rs_.... Доступ ограничивается правами ключа.

Webhook

Если у проекта задан secret, события подписываются заголовком X-RoomSEO-Signature. Payload и пример.

Лимиты

API ограничен по частоте и лимиту страниц, чтобы не перегружать сервис и сайты клиентов.

Быстрый старт

Ключ → запуск → проверка результата.

Создать аудит
curl -X POST https://roomseo.ru/api/v1/audits \
  -H "Authorization: Bearer rs_..." \
  -H "Content-Type: application/json" \
  -d '{"email":"client@example.com","url":"https://example.com","max_pages":100}'
Получить результат
curl -H "Authorization: Bearer rs_..." https://roomseo.ru/api/v1/audits/23.json

Методы API

Право справа должно присутствовать у API-ключа.

9 методов
POST
/api/v1/audits

Создать аудит и получить ссылки на его статус и результат.

audits:write
GET
/api/v1/audits/:id

Получить статус и текущий прогресс выполнения.

audits:read
GET
/api/v1/audits/:id.json

Скачать полный JSON-экспорт готового аудита.

audits:read
POST
/api/v1/audits/:id/retry

Повторить аудит с теми же настройками.

audits:write
POST
/api/v1/audits/:id/cancel

Отменить аудит в очереди или во время выполнения.

audits:write
GET
/api/v1/projects

Получить доступные ключу проекты; email можно передать фильтром.

projects:read
POST
/api/v1/projects/:id/webhook-test

Отправить тестовое событие и получить HTTP-код webhook.

projects:write
GET
/api/v1/tasks

Получить очередь, активные и проблемные аудиты.

tasks:read
GET
/api/v1/health

Проверить API, очередь, базу и свободное место.

без ключа

Статусы аудита

Единые значения для API, webhook и интерфейса.

  • queuedВ очереди
  • runningСканируется
  • completedГотов
  • failedОшибка
  • canceledОтменён