Загрузки

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

Загружаем поисковый индекс…

Загрузки

Объекты

Upload

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • file_namestringобязательно

    Имя файла, данное при начале загрузки.

  • sizeintegerобязательно

    Размер всего файла в байтах.

  • receivedintegerобязательно

    Принято байт: смещение следующей части.

  • completebooleanобязательно

    Файл собран: массовая операция может взять его по id. После этого загрузки больше нет.

  • chunk_bytesintegerобязательно

    Наибольший размер одной части в байтах.

  • expires_atstring (date-time)обязательно

    После этого момента незабранная загрузка удаляется.

  • created_atstring (date-time)обязательно

    Когда запись создана.

Методы

Загрузка файла частями: сколько принято

get/uploads/{upload}

Scope: bulk:read

Параметры

Путь

  • uploadintegerобязательно

    ID загрузки.

Ответы

200Успешно

application/json

Возвращает Upload

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/uploads/{upload}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "file_name": "string",
  "size": 0,
  "received": 0,
  "complete": true,
  "chunk_bytes": 0,
  "expires_at": "2026-01-15T12:00:00Z",
  "created_at": "2026-01-15T12:00:00Z"
}

Начать загрузку файла частями — вход массовой операции

post/uploads

Scope: bulk:write

Параметры

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Тело запроса application/json

  • file_namestringобязательно

    Имя файла, данное при начале загрузки.

    Макс. длина:
    255
  • sizeintegerобязательно

    Размер всего файла в байтах.

    Минимум:
    1
    Максимум:
    268435456

Ответы

201Создано

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true

application/json

Возвращает Upload

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/uploads" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "file_name": "string",
  "size": 1
}
Пример ответа · 201
{
  "id": 0,
  "file_name": "string",
  "size": 0,
  "received": 0,
  "complete": true,
  "chunk_bytes": 0,
  "expires_at": "2026-01-15T12:00:00Z",
  "created_at": "2026-01-15T12:00:00Z"
}

Дописать часть файла сырым телом

post/uploads/{upload}/chunks

Scope: bulk:write

Параметры

Путь

  • uploadstringобязательно

    ID загрузки.

Строка запроса

  • offsetintegerобязательно

    С какого байта файла начинается часть: равен received загрузки, иначе 409 upload_offset_mismatch. Сама часть — сырое тело запроса.

    Минимум:
    0

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Тело запроса application/octet-stream

string (binary)

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true

application/json

Возвращает Upload

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/uploads/{upload}/chunks?offset=<offset>" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @file
Пример ответа · 200
{
  "id": 0,
  "file_name": "string",
  "size": 0,
  "received": 0,
  "complete": true,
  "chunk_bytes": 0,
  "expires_at": "2026-01-15T12:00:00Z",
  "created_at": "2026-01-15T12:00:00Z"
}