XenonFlare

Developer API

Site audit API — ставьте обходы в очередь и читайте результаты программно

Ставьте обходы в очередь перед релизами. Опрашивайте до завершения и забирайте ссылки на отчёты — панель не требуется.

Асинхронные задачи

Ставьте обходы в очередь, опрашивайте до завершения, получайте ссылки на отчёты

Site Audit API использует ту же модель асинхронных задач, что и интеграции CI и cron: POST для постановки в очередь, GET для опроса, а затем — список доступных отчётов после завершения сканирования.

Quick start (curl)

Replace $XF_API_KEY and property IDs with values from your workspace. Full reference: Developer API docs.

curl -s -X POST \
  -H "Authorization: Bearer $XF_API_KEY" \
  -H "Idempotency-Key: scan-$(date +%s)" \
  -H "Content-Type: application/json" \
  -d @scan-body.json \
  https://api.xenonflare.com/api/v1/properties/$XF_PROPERTY_ID/scans

Соберите своего краулера или используйте API XenonFlare

Собирайте внутри компании, если…

  • Безголовые браузерыочереди вежливости и инфраструктура для сканирования
  • Правила скорингатаксономия инцидентов и хранение отчетов
  • Аутентификация интеграторалимиты, идемпотентность и опрос статуса задач
  • Мониторингкогда краулеры упираются в защиту от ботов или проблемы с TLS

Используйте XenonFlare, если…

  • Очередь полных сканов сайтас POST /properties/:id/scans
  • Опрос статуса задачскор и количество инцидентов через GET /jobs/:id
  • Bearer-ключи с областью действиятестовые ключи для CI и генерация кода по OpenAPI
  • Тот же движок краулингакак веб-приложение с оверлеем GSC + API

Как работает клиент

“Мы отслеживаем 40 сайтов клиентов из одного внутреннего dashboard. Ночные пакетные сканирования, уведомления вебхука, если обход завершается с ошибкой, и экспорт активности в CSV для отчётности клиентам — без входа в каждую property.”

Диджитал-агентство использует XenonFlare Developer API на Growth

  • 40 property
  • POST /scans/batch
  • история доставки Webhook
  • экспорт активности в CSV

Типовой сценарий интеграции

  1. Создайте рабочее пространство Starter или Growth и API-ключ с jobs:write
  2. Получите ID свойства через GET /properties
  3. Добавьте скан в очередь с POST /properties/:id/scans
  4. Опросите GET /jobs/:id, пока статус не станет completed или failed

Что вы получаете

Очередь задач SEO-скана всего сайта

Опрос статуса, прогресса и результатов

Список активных ссылок на общий отчет

jobs:read/write, reports:read, properties:read

Idempotency-Key

безопасные повторы для запросов на запись

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

1,000 чтений/ч и 60 записей/ч на ключ (500 записей организации/день)

FAQ

Могут ли агентства перепродавать доступ к API клиентам?

Агентства запускают одно рабочее пространство Growth с размещенными внутри свойствами клиентов и используют ключи с областью действия для дашбордов и ночных сканов. Доставляйте результат через общие ссылки, webhooks или ваш портал — клиентам не нужны API-ключи.

Какой тариф включает Site Audit API?

Доступ к Developer API требует Starter или Growth. Free включает веб-приложение и бесплатные инструменты xenonflare.com, но не включает API-ключи.

Чем это отличается от бесплатного инструмента для аудита?

Бесплатные инструменты дают снимок на одну страницу без аккаунта. API ставит в очередь полные сканы сайта, привязанные к вашему рабочему пространству: с историей задач, лимитами на краулинг по плану и отчетами, которыми можно делиться.

Какие лимиты на частоту запросов у API?

По умолчанию: 1,000 запросов на чтение в час на ключ, 60 запросов на запись в час на ключ и 500 запросов на запись для организации в день. До 5 активных ключей на рабочее пространство. Подробнее — в документации по Developer API.

Developer API в тарифах для платных workspace

Создавайте API-ключи в веб-приложении после апгрейда. Free включает dashboard и бесплатные маркетинговые инструменты — но не REST-ключи.