API и вебхуки
Загрузка и чтение документов доступны через REST API. Управление учетной записью, папками, ярлыками и связями остается в приложении.
Ключ
Создается в Настройках → Для разработчиков. Ключ отображается единожды, при создании — потом уже нет, так как сохраняется только его отпечаток. Утерянный ключ не восстанавливается, создается новый, а старый удаляется. Можно иметь пять ключей, каждый с опциональным сроком действия до двух лет.
Ключ отправляется в заголовке X-API-Key.
Что может API
| Операция | Описание |
|---|---|
POST /api/upload | Загрузка файла с опциями: формат, направление, тип, валюта, схема, папка, вебхук |
POST /api/upload/url | То же самое с публичного адреса; мы загрузим файл сами |
GET /api/jobs | Вывод документов с фильтрами и постраничной навигацией |
GET /api/jobs/{id} | Статус, прочитанные данные, находки и результат в целевом формате |
GET /api/jobs/{id}/original | Загруженный файл |
DELETE /api/jobs/{id} | Удаление в корзину |
Excel и PDF возвращаются в результате в формате Base64. Если результат не нужен, отправьте
includeResult=false, это сэкономит ресурсы сервера.
Описание интерфейса в формате OpenAPI доступно по адресу /api/docs; ссылка есть в настройках
у ключей. Описание генерируется из текущего кода, так что соответствует тому, что делает API.
Проверка документов из API
Проверка перед отправкой по умолчанию также действует для документов, загруженных ключом: документ ожидает подтверждения в приложении, и вебхук уйдет только после него. Если вы разрабатываете интеграцию, где никто не сидит у экрана, в Настройках → Проверка перед отправкой отключите канал API или отключите проверку.
MCP
Для AI агентов по адресу /api/mcp сервер MCP с тем же ключом. Он умеет читать и
искать документы, загрузка невозможна; загрузка вернется как готовая команда, которую агент
запустит самостоятельно.
Вебхуки
Вместо опроса о состоянии получите результат, когда он будет готов. Адрес устанавливается для всей учетной записи в Настройках → Для разработчиков, или у отдельной загрузки параметром targetWebhookUrl. Кнопка в настройках отправляет тестовое сообщение.
Отправляется POST с JSON: идентификатор документа, имя файла, формат и результат
в целевом формате. Когда документ проходит проверку или обрабатывается повторно, вебхук приходит
вторично с признаком исправления (IsCorrection).
Сообщение не подписывается. Проверьте отправителя, добавив ваш собственный секретный токен в адрес. Адреса в частные сети отклоняются.
Неудовлетворительная доставка повторяется с увеличивающейся задержкой, одиннадцать попыток в течение примерно четырех с половиной часов. Каждая попытка фиксируется в активности вместе с ответом вашей стороны; у документа в выводе есть иконка с результатом доставки.
Лимиты
API не имеет собственного ограничения на количество вызовов в минуту; загрузка ограничивается кредитами, размерами файлов по тарифу и двадцатью страницами на документ. Отказ приходит как ошибка 400 с кодом, который объясняет причину. Сервер MCP ограничен десятью запросами в секунду.