api:files

Файлы

Методы

POST /files/upload

Метод загружает файлы для последующего прикладывания их в задачи. Файлы, на которые не ссылается ни одна задача, через некоторое время удаляются.

POST https://api.pyrus.com/v4/files/upload

Authorization: Bearer gAAA***** 
Content-type: multipart/form-data; boundary=8d2f42366b41441
Content-Length: 5222 

--8d2f42366b41441
Content-Disposition: form-data; name="file"; filename="filename.jpg"
Content-Type: application/octet-stream
//тело файла
--8d2f42366b41441--
Показать ответ

{
  "guid": "08923d83-255b-4f18-b0eb-5c4d3b9bf1d2",
  "md5_hash": "cd4df826e3b9ce6e7895d8a31536d99d"
}

curl

curl -X POST \
  https://api.pyrus.com/v4/files/upload \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -F 'filename.jpg=@C:\Path\To\File\filename.jpg'
    

В ответ вы получите идентификатор загруженного файла и хеш файла, вычисленный по алгоритму MD5. Чтобы приложить загруженный файл в задачу, воспользуйтесь методом добавления комментария и передайте полученный идентификатор в поле attachments.

В большинстве языков программирования или программных средств для отправки REST API запросов, например curl или Postman, корректный запрос сформируется автоматически, если при передаче данных указать тип кодирования multipart/form-data. Таким образом для успешной загрузки файла в заголовках достаточно указать в разделе Authorization cвой ключ авторизации, а в теле запроса — путь к файлу.

Загружайте ровно один файл, используя указанный запрос. Если необходимо загрузить несколько файлов, запустите запрос несколько раз соответственно. Максимальный размер прикладываемого файла — 250 Mb.

GET /files/download/{file-id}

Метод скачивает файл из pyrus.

GET https://api.pyrus.com/v4/files/download/1334
Показать ответ

Content-Disposition: attachment; filename=test.txt
Content-Length: 12
Content-Type: application/octet-stream

file content

curl

curl -X GET \
  https://api.pyrus.com/v4/files/download/1334 \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -H 'Content-Type: application/json'
    

Была ли эта статья полезной?

Да, спасибо! Нет, остался вопрос