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

Ошибки и лимиты

Ошибка приходит в теле JSON с полями error (или msg) и code. HTTP-код у большинства методов — 200, поэтому проверяйте поле code, а не только статус ответа. Ниже — общие ошибки; ошибки конкретного метода описаны на его странице.

Инструменты: ключ и вызов

Код	Сообщение	Когда
`-1`	`Access denied`	Не передан `key` (HTTP 404).
`-2`	`Access denied`	Ключ не найден или тариф без доступа к API (HTTP 403).
`-3`	`Unknown method`	Такого метода нет (HTTP 404).
`-50`	`Not set` / текст	Не передан обязательный параметр — его имя будет ключом в ответе, например `{"url": "Not set", "code": "-50"}`.
`-60`	`To many tasks from one user…`	Слишком много одновременных задач — см. Асинхронные задачи.

Лимиты тарифа

Перед запуском проверяется, хватает ли лимитов на час, день, неделю, месяц и год. В ответе — сколько доступно (available) и сколько нужно (need). Остаток лимитов — метод getlimits.

Код	Сообщение
`-80`	`Not enough hourly limits`
`-68`	`Not enough daily limits`
`-81`	`Not enough weekly limits`
`-82`	`Not enough monthly limits`
`-83`	`Not enough yearly limits`

{
    "error": "Not enough daily limits",
    "code": "-68",
    "available": 120,
    "need": 500
}

SEO-проекты

Ответ в обёртке {"status": "error", "code": …, "msg": …, "result": …}, HTTP 200.

Код	msg	Когда
`0`	`wrong action`	Неизвестное действие.
`2`	`empty request`	Пустой запрос.
`50`	`access error`	Токен не найден или нет доступа к проекту.
`51`	`wrong project id`	Нет `project_id` или такого проекта.
`52`	`wrong request data`	Неверные параметры; подробность — в `result.error`.
`53`	`wrong queries ids`	Неверные id запросов.
`54`	`service unavailable`	Сервис временно недоступен.

REST API

Код и сообщение об ошибке возвращаются в теле ответа; при неверном или просроченном JWT — 401 с текстом Token is not authorized. Подробнее — на странице Авторизация REST API.