Возможности и документация API

REST API Консоль.Про позволяет автоматизировать работу с платформой из вашей CRM, 1С, собственного сервера или другой внешней системы — без ручных действий в личном кабинете.

API использует стандарт REST: запросы и ответы в формате JSON, стандартные HTTP-коды ответов. Базовый адрес: https://api.konsol.pro/

Для доступа к API нужен API-токен. Как его получить — в статье «Получение API-токена».

С актуальной документацией по работе API можно ознакомиться на docs.konsol.pro

Важно: те же правила, что в личном кабинете

Интеграция через API использует те же бизнес-процессы, что и работа в ЛК:

• лимиты, статус «Мой налог», реквизиты исполнителя могут блокировать выплату — и через API, и через кабинет;
• статус операции в кабинете виден сразу, через API его нужно запрашивать соответствующими методами.

Если действие недоступно в личном кабинете, оно не станет доступным через API.

Как начать работу

1. Получите API-токен

Пошаговая инструкция с иллюстрациями — в статье «Получение API-токена».

2. Изучите документацию

Актуальная документация по методам API: здесь

Там же — описание заголовков авторизации, форматов запросов и кодов ответов.

3. Настройте интеграцию

Передайте токен вашему разработчику или настройте готовый модуль.

Частые вопросы и ошибки

«Ваш IP не имеет доступ к текущему токену»

IP-адрес, с которого отправлен запрос, не входит в список разрешённых для токена.

Что сделать: добавьте IP сервера в настройках токена (⋮ → Изменить) или создайте токен без ограничения по IP, если политика компании это допускает.

«Необходимо передать действующий токен в заголовке запроса»

Токен не передан, передан не полностью или с ошибкой.

Что сделать: скопируйте токен заново (⋮ → Скопировать), проверьте заголовок авторизации по документации.

Ошибки 401 / 403

Возможные причины: неверный токен, ограничение по IP, недостаточно прав у сотрудника, создавшего токен (нужен Админ).

Ошибки 404 / 422

• 404 — проверьте URL метода по документации; эндпоинт мог измениться.
• 422 — ошибка валидации полей в JSON; сверьте тело запроса со схемой в docs.konsol.pro.

Метода нет в документации

Если в docs.konsol.pro нет нужного метода — напишите в чат поддержки или менеджеру: опишите сценарий, мы оценим возможность доработки API под ваши задачи.