Документация API

Ключ API и доступ

Один ключ API открывает и методы инструментов, и методы SEO-проектов. Ключ привязан к аккаунту: запросы выполняются от вашего имени, расходуют ваши лимиты и видят только ваши проекты и проекты, к которым вам выдан доступ.

Где получить ключ

На странице аккаунта в блоке «Ключ API» нажмите «Сгенерировать». Повторная генерация выпускает новый ключ, старый сразу перестаёт работать — обновите его во всех скриптах.

API доступно на платных тарифах. На бесплатном тарифе ключ не выпускается, а запросы со старым ключом получают Access denied.

Как передавать

APIГде ключПример
Инструментыquery-параметр key — всегда в адресе, даже у POST-запросов/api/getlimits?key=…
SEO-проектыquery-параметр token — тот же ключ/projects/api/v1/projects/get?token=…
REST APIHTTP-заголовок token с JWT, полученным методом user/authtoken: eyJ…

Безопасность

  • Не публикуйте ключ в открытом коде и не передавайте его в браузерные скрипты: с ключом можно тратить ваши лимиты и менять ваши проекты.
  • Ключ в адресе попадает в логи прокси и историю — вызывайте API с сервера.
  • Если ключ утёк — перевыпустите его на странице аккаунта.

Ошибки

КодСообщениеКогда
-1 Access denied Ключ не передан (HTTP 404).
-2 Access denied Ключ не найден или тариф не даёт доступа к API (HTTP 403).
50 access error SEO-проекты: токен не найден или нет доступа к проекту.
401 Token is not authorized REST API: JWT не передан, просрочен или подпись неверна.
Обратная связь и помощь
Если у вас есть идеи, как улучшить данный инструмент или остались вопросы по работе с ним, напишите в нашу службу поддержки, мы обязательно вам поможем.