API файлового хранилища

FileStorage — сервис управления файлами и связанными сущностями.

Сервис FileStorage предоставляет API для загрузки, хранения, обработки, получения и управления файлами, а также для работы с тегами, аватарами, статистикой и безопасностью доступа к файлам. Он поддерживает работу с различными типами сущностей (клиенты, контракты, лиды, заявки), массовые операции, интеграцию с OCR, верификацию изображений.

Работа с сервисом

Основные возможности:

• Загрузка, обновление, удаление и получение файлов по ID и по сущностям (клиенты, контракты, лиды, заявки).

• Массовая загрузка и обработка файлов, получение ссылок на группы файлов.

• Публичная загрузка файлов и получение публичных ссылок.

• Верификация изображений, запуск и получение результатов OCR-обработки.

• Управление тегами: создание, обновление, удаление, публикация, изменение порядка.

• Получение статистики по файлам, тегам и другим сущностям.

API-маршруты

Методы работы с файлами

Метод	URL	Описание
POST	api/files	Загрузка файла
GET|HEAD	api/files	Список всех файлов
PUT|PATCH	api/files/{file}	Обновить файл
GET|HEAD	api/files/{file}	Получить информацию о файле по ID
DELETE	api/files/{file}	Удалить файл
GET|HEAD	api/files/{file}/links	Получить ссылки на файл
GET|HEAD	api/files/{file}/link-verified-copy	Получить проверенную копию файла
POST	api/files/batch/links	Получение ссылок на группу файлов (по ID)
POST	api/files/batch/select	Получение информации по группе файлов
POST	api/files/entities/clients/{id}	Загрузить файл клиента
GET|HEAD	api/files/entities/clients/{id}	Получить файлы клиента
POST	api/files/entities/contracts/{id}	Загрузить файлы контракта
GET|HEAD	api/files/entities/contracts/{id}	Получить файлы контракта
POST	api/files/entities/leads/{id}	Загрузить файлы лида
GET|HEAD	api/files/entities/leads/{id}	Получить файлы лида
POST	api/files/entities/loan-apps/{id}	Загрузить файлы заявки
GET|HEAD	api/files/entities/loan-apps/{id}	Получить файлы заявки
GET|HEAD	api/files/public-uploader	Публичная загрузка файла

Методы работы с тегами категорий файлов

Метод	URL	Описание
GET|HEAD	api/tags	Получение списка тегов
POST	api/tags	Создание нового тега
PUT|PATCH	api/tags/{tag}	Обновление тега
GET|HEAD	api/tags/{tag}	Получение информации о теге
DELETE	api/tags/{tag}	Удаление тега
PUT	api/tags/{tag}/changeOrder	Изменение порядка тегов
PUT	api/tags/{tag}/publish	Публикация тега
PUT	api/tags/{tag}/unpublish	Снятие публикации тега

Оптическое распознавание текста (OCR)

Метод	URL	Описание
POST	api/files/{fileId}/ocr	Запуск OCR-обработки файла
GET|HEAD	api/files/{fileId}/ocr/{ocrId}	Получить результат OCR по ID