APIDOCINSPECT

Кабинет и обработка без кода

Вход по ссылке, ключи и расход, раздел «Обработка документов» — тип документа, колонки, файл, Excel с переводом. И как повторить то же самое через API.

Кабинет — вторая дверь к тому же сервису: там, где интеграции нужен X-API-Key, человеку достаточно почты. В кабинете выдаются и отзываются ключи, виден расход за месяц — и работает раздел «Обработка документов», который делает то же, что /v1/process, но мышкой: тип документа → колонки → файл → Excel.

Вход — по ссылке из письма

Паролей в системе нет. Вы вводите адрес на странице входа, на почту приходит одноразовая ссылка, переход по ней открывает сессию на 90 дней.

  • Ссылка действует 15 минут и гасится первым использованием. Повторный переход по уже использованной ссылке гасит все ваши сессии: если ссылкой воспользовался кто-то другой, лучше разлогинить всех.
  • Ответ на запрос ссылки всегда одинаковый — «если такой адрес зарегистрирован, письмо отправлено». По нему нельзя узнать, есть ли аккаунт у конкретного адреса.
  • При первом входе выдается первый API-ключ — его значение показывается один раз, в момент выдачи. Потерянный ключ не восстанавливается, выпускается новый.

Ключи, тариф и квоты

В разделе «Ключи» — список ключей: префикс, метка, дата создания, дата последнего использования. Значение ключа не хранится в открытом виде и в списке не показывается. Отзыв — мягкий: ключ перестает работать, но остается в списке вместе с историей расхода.

  • Активных ключей на аккаунт — не больше пяти (KEY_LIMIT_REACHED).
  • Тариф и остаток страниц видны в разделе расхода: сколько страниц потрачено за календарный месяц, по дням и по видам задач (process:extract, process:prompt, …). Квота сбрасывается в начале месяца.
  • Смена тарифа — заявка из кабинета: тариф поднимает администратор, автоматически он не меняется. Цены и пакеты страниц — на странице тарифов, механика предохранителей — в «Аутентификации».

Обработка документов — шаг за шагом

Раздел /app/process — один экран, четыре блока сверху вниз, без мастера.

1. Документ: тип, язык, перевод

Плитки сгруппированы: «Внешняя торговля», «Бухгалтерия», «Инженерия», «Своё». Тип задает три вещи: инструкцию для модели (вы ее не видите и не правите), подсказку парсеру document_type и стартовый набор колонок.

Рядом — язык документа (русский / английский / китайский) и переключатель «Перевести на …». Язык нужен не для красоты: китайский скан без language=zh распознается плохо.

2. Колонки

Два списка чипов: реквизиты (шапка документа) и позиции (строки таблицы). Лишнюю колонку можно убрать крестиком, свою — добавить словами («Страна происхождения»), кнопка возвращает стандартный набор типа.

Правки колонок сохраняются в вашем браузере по типу документа — серверного хранения наборов сейчас нет. Другой браузер или чужой компьютер покажет набор «как из коробки».

3. Файл

PDF, Word, Excel, CSV, фото и сканы (JPG, PNG, TIFF, WebP), XML — до 50 МБ. Формат и размер проверяются в браузере до отправки, чтобы не тратить время на заведомо отклоняемый файл. Полный список форматов — в «Форматах и лимитах».

4. Результат

Обработка идет асинхронно (обычно от 10 секунд до 2 минут, на экране — счетчик). Когда готово:

  • реквизиты — три колонки: поле, значение как в документе, перевод;
  • позиции — первые 50 строк на экране, остальные есть в файле;
  • «Скачать Excel» — лист «Документ» с реквизитами и итогами и отдельный лист на таблицу позиций;
  • предупреждения из warnings[] человеческим языком и число списанных страниц.

Если в файле оказалось несколько документов, на экране показывается первый, а в Excel попадают все.

Файл и результат живут час

Документ обрабатывается в памяти запроса и не сохраняется, результат задачи хранится час и потом удаляется. Скачивайте Excel сразу или забирайте результат по ссылке в течение часа.

Какие типы документов есть

Реквизиты и позиции ниже — стартовый набор колонок; любой из них правится перед запуском.

Тип документаРеквизитыПозиции
Упаковочный лист (внешняя торговля)Номер, дата, отправитель, получатель, номер инвойса, мест всего, брутто и нетто, кгАртикул, наименование, количество, единица, мест, брутто, нетто, объем
ИнвойсНомер, дата, продавец, покупатель, валюта, условия поставки, итогоАртикул, наименование, количество, единица, цена, сумма
Прайс-листПоставщик, дата, валютаАртикул, наименование, единица, цена, минимальный заказ
Спецификация к контрактуНомер, дата, контракт, продавец, покупатель, итогоАртикул, наименование, количество, единица, цена, сумма, код ТН ВЭД
CMR-накладнаяНомер CMR, дата, отправитель, получатель, перевозчик, места погрузки и разгрузки, транспортное средство, мест всего, брутто, объемМарки и номера, мест, род упаковки, наименование груза, брутто, объем
УПД / счет-фактура (бухгалтерия)Номер, дата, продавец с ИНН и КПП, покупатель с ИНН, итого без НДС, сумма НДС, итого с НДСНаименование, количество, единица, цена, сумма без НДС, ставка и сумма НДС, сумма с НДС
Акт выполненных работНомер, дата, исполнитель и заказчик с ИНН, основание (договор), итого без НДС, НДС, итогоНаименование работ, количество, единица, цена, сумма
Товарная накладная (ТОРГ-12)Номер, дата, поставщик и грузополучатель с ИНН, основание, итогоКод/артикул, наименование, количество, единица, цена, сумма с НДС
ДоговорНомер, дата, обе стороны с ИНН, предмет, сумма и валюта, срок действия, порядок оплаты, подписанты— (табличной части нет)
Чертеж → спецификация (инженерия)Обозначение, наименование изделия, масштаб, разработал, организацияПозиция, обозначение, наименование, количество, материал или примечание
Свой набор (свое)задаете самизадаете сами

Имена реквизитов CMR совпадают с тем, что проверяют серверные валидаторы, поэтому на результате срабатывают проверки «нетто ≤ брутто» и «отправитель ≠ перевозчик» — они приходят в warnings[] (см. «Ошибки»).

То же самое через API

Кабинет не делает ничего, чего нельзя сделать запросом. Соответствие прямое:

В кабинетеВ /v1/process
Тип документаdocument_type + внутренняя инструкция (свою пишите в prompt)
Колонкиoutput_schema: реквизиты — скаляры, позиции — массив объектов
Подпись колонкиtitle свойства схемы — он же становится заголовком столбца в Excel
Язык документаlanguage (ru/en/zh)
«Перевести на …»translate: {"to": "ru"}
«Скачать Excel»GET /v1/process/{task_id}?format=xlsx

client_meta повторять не нужно: это служебная телеметрия самого кабинета (какой тип документа и сколько колонок выбрано), на обработку она не влияет. Готовый запрос под такой сценарий — в «Готовых сценариях», поля схемы — в «output_schema».

Чем списывается обработка из кабинета

Обработка в кабинете идет по сессии, без X-API-Key, но бесплатной от этого не становится: страницы списываются на ваш активный ключ с максимальным тарифом. Если ключей еще нет, сервис заводит обычный ключ с меткой «Кабинет» — он виден в разделе «Ключи» и отзывается как любой другой.

Предохранители тарифа те же, что у API: скорость, потолок страниц на один документ и месячная квота. Исчерпанная квота в кабинете показывается текстом со ссылкой на тариф, а не кодом ошибки — сам код тот же QUOTA_EXCEEDED (см. «Ошибки»).

On this page