API WebsiteCoach
Используйте API WebsiteCoach для получения кэшированных отчетов и приоритетных задач для внутренних панелей, клиентских порталов и автоматизации.
Ludwig Makhyan · Основатель, WebsiteCoach
Перейти к разделу
Для чего нужен API WebsiteCoach
API WebsiteCoach дает зарегистрированным пользователям программный доступ к тем же данным отчетов, которые доступны в приложении. Он подходит для внутренних панелей, клиентских порталов, отчетности и автоматизации, которым нужны данные о состоянии сайта в формате JSON.
Публичная документация намеренно не раскрывает приватные токены, внутренние детали реализации, админские маршруты или чувствительные настройки сканирования. Пользователи создают и управляют своими API-токенами в личном профиле после входа.
Кэшированный отчет JSON
Получайте последний сохраненный отчет по домену, включая оценки, метрики, отделы и поля с доказательствами.
Эндпоинт задач
Получайте только приоритетный список исправлений, включая приоритет, отдел, описание, метрику, цель и уровень уверенности.
AI-промпты для исправлений
Получайте готовые к копированию промпты для AI-инструментов разработки, с доказательствами аудита, URL, ссылками на обучение и ручными инструкциями для исправлений на стороне провайдера.
Доступ с учетом истории
Просмотры отчетов через API привязаны к аутентифицированному пользователю, поэтому те же домены отображаются в истории аккаунта и админки.
Управление токенами
Пользователи могут создавать отдельные токены для разных инструментов и отзывать токен без раскрытия паролей или сессий.
Публичные API-эндпоинты
Полный кэшированный отчет
Используйте это, когда приложению нужен полный сохраненный отчет по домену.
GET https://websitecoach.com/api/reports?url=example.com&token=YOUR_TOKEN&lang=enТолько задачи
Используйте для создания тикетов, руководящих панелей или интеграций, которым нужен только приоритетный список исправлений.
GET https://websitecoach.com/api/actionitems?url=example.com&token=YOUR_TOKEN&lang=enAI-payloads для исправлений
Используйте, когда ваш workflow отправляет находки WebsiteCoach в ChatGPT, Claude, Gemini, Cursor или другой AI-ассистент для разработки.
GET https://websitecoach.com/api/payload?url=example.com&token=YOUR_TOKENОтвет возвращает каждый action item с отделом, приоритетом, ссылкой на обучение, доказательствами аудита и структурированным промптом. Промпты требуют, чтобы AI сначала изучил стек пользователя, а если исправление относится к DNS, CDN, email, регистратору, CMS или другой внешней консоли, дал подробный ручной runbook вместо выдуманных изменений кода.
Формат Bearer-токена
Серверные приложения могут отправлять токен в заголовке Authorization вместо query string.
Authorization: Bearer YOUR_TOKENБезопасность токенов и данных
Храните токены на сервере
- Не размещайте API-токены в публичном JavaScript, мобильных приложениях, скриншотах или общих документах.
- Создавайте отдельные токены для отдельных приложений, чтобы одну интеграцию можно было отозвать, не ломая остальные.
- Используйте только HTTPS и ротируйте токены, когда коллега, подрядчик или система больше не нуждаются в доступе.
- API возвращает только данные отчетов, доступные владельцу аутентифицированного токена; он не раскрывает пароли, сессии, платежные секреты, админские маршруты или приватные crawl-заголовки.
Доступ и лимиты
API-доступ доступен зарегистрированным пользователям. Каждый пользователь может создать до 10 активных API-токенов в профиле.
API-вызовы предназначены для получения кэшированных отчетов и workflows задач. Свежие сканы и обновления за кредиты могут меняться, поэтому публичные интеграции должны опираться на документированные эндпоинты отчетов и задач.
Чтобы создать или отозвать токены, войдите и откройте API tokens.
Нужна приватная интеграция?
Для партнерских или корпоративных сценариев свяжитесь с WebsiteCoach перед использованием непубличного поведения. Публичная документация является стабильным контрактом.
Похожие темы