Files

Скачивание файла

Отдаёт сам файл, а не ссылку на него. Нужен для вложений, у которых прямой ссылки на хранилище нет: в поле url у них стоит адрес этого метода, и открыть его можно только с токеном. Так отдаются зашифрованные файлы и отправленные из безопасного контура пространства — обе настройки описаны в разделе Шифрование и безопасный контур.

Отказ приходит 403 с кодом confidential_download_denied. Сверяется при этом адрес, с которого пришёл запрос, то есть адрес вашего сервера, а не сотрудника, чьим токеном вы пользуетесь: для серверной интеграции это самая частая причина отказа.

Ответ — тело файла и заголовок Content-Disposition с его именем, а не JSON. Зашифрованный файл расшифровывается на лету и приходит вложением целиком: target для него не действует. Если расшифровать не удалось, ответ — 400 с кодом decryption_failed.

Вложение сообщения доступно тому, кто видит само сообщение, а вложение черновика — только его автору.

get/files/{id}

Request

  • Base URL: https://api.pachca.com/api/shared/v1
  • URL: https://api.pachca.com/api/shared/v1/files/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required
Example:3560

Идентификатор файла из поля id вложения

Query parameters

target'pdf_preview' | 'pdf_first_page' | 'thumb' | 'image'

Что отдать вместо исходного файла

Что отдать вместо исходного файла: pdf_preview — документ, переведённый в PDF, pdf_first_page — первая страница картинкой, thumb — уменьшенная копия изображения, image — изображение как есть. Без параметра приходит исходный файл. Вариант, которого у этого файла нет, приводит к 400.

Response

The request has succeeded.

Changes

No recorded changes to this operation across all 1 revision of this API.