API файлового хранилища
API файлового хранилища Brainysoft предоставляет комплексный набор методов для управления файлами, их категоризацией и автоматической обработки документов.
Система позволяет:
- загружать файлы
- привязывать файлы к объектам системы (клиентам, контрактам, лидам, заявкам)
- организовывать файлы по категориям через теги
- использовать оптическое распознавание текста для автоматизации обработки документов.
TIP
Для получения домена API необходимо направить заявку на развертывание сервиса через Brainysoft Support (https://support.brainysoft.ru). Заявка принимается только от официально зарегистрированного уполномоченного представителя Лицензиата.
Для корректного вызова всех методов необходимо в заголовках запроса (Headers) передавать:
| Заголовок | Описание |
|---|---|
customer-key | Идентификатор клиента |
bsauth | Токен авторизации |
Получение токена (bsauth) описано в сервисе авторизации: Сервис авторизации
Основные возможности
Работа с файлами
API для работы с файлами предоставляет полный функционал управления документами в системе:
- Загрузка файлов — загрузка новых файлов в систему с поддержкой различных форматов
- Получение информации — просмотр списка всех файлов и детальной информации по конкретному файлу
- Редактирование — обновление метаданных загруженных файлов
- Удаление — полное удаление файлов из системы
- Получение ссылок — генерация временных ссылок для доступа к файлам и их верифицированным копиям
- Массовые операции — пакетная обработка файлов (получение ссылок и информации по группе файлов)
- Привязка к объектам системы — загрузка и получение файлов, привязанных к клиентам, контрактам, лидам и заявкам
- Публичная загрузка — возможность загрузки файлов без авторизации для публичных сценариев
Работа с тегами категорий файлов
Система тегов позволяет организовать файлы по категориям и упростить их поиск и структурирование:
- Создание тегов — создание новых категорий для классификации файлов
- Получение списка — просмотр всех доступных тегов с их атрибутами
- Обновление тегов — редактирование названий и других параметров тегов
- Удаление тегов — удаление ненужных категорий
- Изменение порядка — настройка последовательности отображения тегов
- Публикация — управление видимостью тегов (публикация и снятие публикации)
- Статистика — получение статистической информации по использованию тегов
Оптическое распознавание текста (OCR)
В файловом хранилище работает ОРТ (Оптическое распознавание текста, OCR) от партнера DBrain.
Текущие возможности OCR:
- Распознавание главного разворота внутреннего паспорта РФ — автоматическое извлечение данных из паспорта
- Сравнение селфи — проверка соответствия фотографии на селфи с фотографией в документе
OCR позволяет автоматически преобразовывать текст на изображениях, сканах документов или фотографиях в редактируемый и поисковый текстовый формат, что значительно упрощает обработку документов и автоматизацию процессов.
Функциональность OCR:
- Запуск OCR-обработки файлов
- Получение результатов распознавания с детальной информацией
- Настройка параметров распознавания (пороги уверенности, режимы проверки)
- Автоматический запуск распознавания для файлов с определенными тегами