Интеграции
API нужен для автоматической работы с инструментами сервиса: запуска генерации sitemap.xml, получения готовых файлов, выгрузки ссылок из XML-карты сайта и проверки русского текста без ручного входа в кабинет.
API помогает связать sitemap-seo.ru с CRM, CMS, внутренней админкой, SEO-панелью или вашим скриптом. Через него можно получать результаты генерации карты сайта, передавать данные в отчеты, запускать отдельные инструменты и собирать результаты в своем интерфейсе.
Доступ берется в админке в разделе API-токены. Токен привязан к конкретному сайту, поэтому его можно безопаснее выдавать подрядчику или клиенту только для нужного домена.
API уже подключен к проекту. Публичные запросы принимаются через отдельный слой /api/v1/public и требуют заголовок X-API-Key. Следующим этапом можно добавить лимиты по тарифам и расширенный журнал запросов.
Клиенту или разработчику нужно передать базовый адрес API, персональный токен сайта и список разрешенных методов. Токен передается только на сервере, в заголовке X-API-Key. Не вставляйте токен в открытый JavaScript на сайте, чтобы его не смогли скопировать посторонние.
После выдачи токена сервис сможет принимать запросы от вашего сайта или серверного приложения. Например, можно отправить адрес sitemap.xml и получить список ссылок, запустить генерацию карты сайта, запросить статус сканирования или подключить проверку текста к редактору CMS.
GET /api/v1/public/me
POST /api/v1/public/scans
GET /api/v1/public/scans/{scan_id}
GET /api/v1/public/scans/{scan_id}/sitemap.xml
POST /api/v1/public/tools/parse-sitemap
POST /api/v1/public/tools/check-spelling
curl -X GET "https://sitemap-seo.ru/api/v1/public/me" ^
-H "X-API-Key: wc_ваш_токен"curl -X POST "https://sitemap-seo.ru/api/v1/public/tools/parse-sitemap" ^
-H "Content-Type: application/json" ^
-H "X-API-Key: wc_ваш_токен" ^
-d "{\"sitemap_url\":\"https://site.ru/sitemap.xml\"}"curl -X POST "https://sitemap-seo.ru/api/v1/public/scans" ^
-H "Content-Type: application/json" ^
-H "X-API-Key: wc_ваш_токен" ^
-d "{\"start_url\":\"https://site.ru/\",\"settings\":{\"max_pages\":1000}}"API-ключ для генерации разрешает запуск только для домена, к которому он привязан. Это защищает аккаунт от случайного использования токена на чужих сайтах. Для проверки текста и парсинга sitemap.xml токен подтверждает право пользоваться внешним API сервиса.
Вопросы и ответы
Ответы для разработчиков, владельцев сайтов и SEO-специалистов, которые хотят подключить инструменты к своим системам.
API нужен для автоматического запуска генерации sitemap.xml, получения статуса проверки, скачивания готовых файлов, парсинга ссылок из XML-карты и подключения проверки текста к CMS или внутренней панели.
Токен нужно хранить на серверной стороне проекта. Не размещайте его в открытом JavaScript, HTML или публичном репозитории, чтобы посторонние не смогли выполнить запросы от вашего имени.
Да, если токен привязан к конкретному сайту и ограничен нужными методами. Такой подход удобен для SEO-аудита, поддержки проекта и обмена данными с внешней системой без доступа к админке.
Обычно передается адрес сайта, ссылка на sitemap.xml или текст для проверки. Запрос должен содержать заголовок X-API-Key, а тело отправляется в JSON-формате.
Начните с метода проверки токена, затем выполните один тестовый запрос к инструменту и проверьте ответ. Если статус успешный и данные возвращаются в ожидаемом формате, интеграцию можно подключать к рабочему процессу.
Да, для рабочего проекта лучше выдавать токен только под конкретный сайт и набор методов. Так проще контролировать интеграцию, отслеживать запросы и снижать риск случайного использования доступа.