RoomSEO API

Интеграции

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

Авторизация

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

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

POST /api/v1/audits

Создать аудит. Возвращает ID, проект и ссылки на статус/аудит.

GET /api/v1/audits/:id

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

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

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

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

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

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

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

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

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

GET /api/v1/tasks

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

GET /api/v1/health

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

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

queued — в очереди · running — сканируется · completed — готов · failed — ошибка · canceled — отменен.