Skip to content

Получить статус файла и временную ссылку по id

Request

Администратор может читать собственные доступные файлы и делегированные CARD/BLOG/AVATAR своего салона при наличии соответствующего права. Приватные документы владельца салона не становятся доступными администратору.

Возвращает текущее состояние файла и, если файл уже доступен локально или в object storage, ссылку. Для purpose DOCUMENT и SUPPORT это ссылка на /api/file/download/{id}; endpoint скачивания проверит доступ и вернёт расшифрованный файл потоком. Для остальных purpose возвращается временная подписанная ссылка на /api/file/download/{id} независимо от текущего места хранения. Файл с purpose QR доступен по известному id без авторизации; остальные файлы сохраняют прежние ограничения доступа.

Query-параметр type выбирает, какую ссылку вернуть:

  • FULL — полный файл
  • PREVIEW — preview файла, если он включён для purpose

Значения data.status:

  • PENDING — файл ещё обрабатывается, url = null
  • FAILED — обработка завершилась ошибкой, url = null
  • UPLOADED — файл доступен; для DOCUMENT url ведёт на защищённый endpoint скачивания, для других purpose может быть временной ссылкой

После успешного ответа upload документ уже имеет UPLOADED. Передайте его file_id в PUT /api/business-registry/registration или PUT /api/business-registry/registration/documents/reupload.

Требования:

  • для purpose QR авторизация не нужна;
  • для остальных файлов требуется JWT.
Path
idinteger, (int64), >= 1required

Идентификатор файла

Query
typestring

Тип ссылки. По умолчанию FULL

Default:"FULL"
Enum:"FULL""PREVIEW"
curl -i -X GET \
  'https://felmee.com/api/file/{id}?type=FULL'

Responses

Статус файла успешно получен

Bodyapplication/json
codeErrorstring or nullrequired

Устаревший camelCase-alias поля error_code; при ошибке оба поля содержат одинаковое значение.

successbooleanrequired

Флаг успешного выполнения запроса

messagestringrequired

Человекочитаемое описание результата

error_codestring or null(ERROR_CODE)required

Код ошибки. Для успешных ответов всегда null.

Enum:"INVALID_BODY""INVALID_DATE""invalid_body""unauthorized""not_found""slot_unavailable""conflict""BUSINESS_INACTIVE""INSUFFICIENT_FUNDS""REQUISITES_REQUIRED"
dataobject or null(FileStatusData)required

Полезная нагрузка. Может быть объектом, массивом или null.

Response
{ "success": true, "message": "File is still processing", "codeError": null, "error_code": null, "data": { "file_id": 123, "file_name": "avatar.png", "status": "PENDING", "url": null } }