Загрузка файла (изображения, документа) на сервер и получение uuid идентификатора необходимо, например, для использования файла в качестве логотипа мероприятия при создании его черновика методом "Создание мероприятия от имени пользователя" или при ответе на вопрос анкеты, где предполагается загрузка документа методом "Ответ на опрос".

Загрузка на сервер производится в 3 шага:

1. Запрос на загрузку файла POST методом /users/{userId}/uploads

2. Загрузка файла PUT методом по url полученному на 1 шаге

3. Запрос завершения загрузки POST методом /users/{userId}/uploads/{uploadId}/complete

Пример:

1. Запрос на загрузку файла, в теле которого указывается название файла и его размер :

POST

https://apps.leader-id.ru/api/v1/users/{userId}/uploads

Тело запроса:

{
    "name": "test1.png",
    "size": 4627
}

В случае успеха в ответе будет:

{
    "url": "https://storage.yandexcloud.net/leader-id/upload/{userId}/455e2253-3fc6-44bc-9f13-04216d11bbf4.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=W--ZMkuGlPP6O_ULzCBV%2F20240425%2Fru-central1%2Fs3%2Faws4_request&X-Amz-Date=20240425T081503Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Signature=fa7af890a568123b65a2a78d376cdaeeb8a9add91e53d9b67185176c781e8d54",
    "uploadId": "f7fcb944-bb3f-47af-8f66-47d7bf98f88c"
}

url — адрес, по которому необходимо загружать сам файл на 2-ом шаге

uploadId — идентификатор uuid, который потребуется на 3-ем шаге

2. Отправляется PUT запрос на полученной url на 1-ом шаге и прикладывается сам файл как Raw Binary. Content-Type: image/jpeg

В случае успеха в ответ придет код "200".

3. Отправляем POST запрос, в котором указываем uuid полученный на 1-ом шаге:

https://apps.leader-id.ru/api/v1/users/{userId}/uploads/7eb1ec4a-f5ef-488a-ac50-0b8ae5523858/complete

В случае успеха в ответ придет код "200"

В начало