ShelfUpload (V2)
Загружает целиком содержимое документа на полку документов, генерирует для него имя и возвращает это имя в ответе.
Максимальный размер документа, который можно загрузить этим методом, — 3 МБ. Для документов большего размера используйте методы ShelfUploadPartInit и ShelfUploadPart, чтобы загрузить документ по частям.
Подробнее про загрузку документов на полку в разделе Загрузка документа на полку.
POST /V2/ShelfUpload
Параметры запроса
fileExtension— расширение файла с точкой. Укажите, чтобы при скачивании файла его имя содержало расширение. Необязательный параметр.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Тело запроса
Тело запроса должно содержать фрагмент документа. Максимальный размер документа — 3 МБ.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.403— запрос сделан от заблокированного клиента API.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит строку со сгенерированным именем файла, загруженного на полку.
Метод не позволяет задать имя на полке для загруженного документа: содержимое всегда сохраняется на локальную полку текущего пользователя, а имя — автоматически присваивается при генерации и возвращается в ответе. Если для дальнейшего использования нужно указать имя вместе с пространством имен, то добавьте к сгенерированному имени префикс __userId__/ — такой формат требуется, например, для файлов МЧД в поле Contents структуры PowerOfAttorneyToPost.
Если документ успешно загружен, то он становится доступным для чтения с полки документов:
- его имя можно указать в поле
NameOnShelfструктур SignedContent и UnsignedContent, - документ можно скачать с полки методом ShelfDownload (V2).
Содержимое фрагмента нужно передать одним из способов:
- в виде бинарных данных — укажите заголовок
Content-Type: application/octet-stream; - в кодировке base64 — укажите заголовок
Content-Type: base64: сервер декодирует тело и сохраняет на полку полученные байты.
Примеры использования
Пример HTTP-запроса:
POST /V2/ShelfUpload?fileExtension=.txt HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/octet-stream
Пример ответа:
dd-api-6831e2e9-cc81-48d5-807d-fe51c2037d44
См. также
Методы для работы с полкой документов:
- ShelfDownload (V2) — загружает содержимое документа с полки документов
- ShelfUpload (V2) — загружает целиком содержимое документа на полку документов
- ShelfUploadPart — загружает фрагмент содержимого документа на полку документов, если первая его часть уже была загружена методом ShelfUploadPartInit
- ShelfUploadPartInit — загружает первый фрагмент документа на полку документов