Загрузка больших файлов
Файл можно передать одним запросом POST /v1/cards, если он не больше лимита
загрузки установки (по умолчанию 200 МБ). Если файл больше или сеть такая, что долгий запрос, скорее всего,
оборвётся, загружайте файл по частям:
- Создайте загрузку: сообщите Sursa имя, тип и размер файла.
- Отправьте части — в любом порядке и, если хотите, параллельно. Неудавшаяся часть отправляется заново отдельно.
- Завершите загрузку, передав SHA-256 всего файла. Sursa соберёт файл и проверит его.
- Используйте идентификатор загрузки вместо файла: для карточки, архива или документа своего источника.
| Ограничение | Значение |
|---|---|
| Размер файла | До 5 ГБ |
| Размер части | Выбирает Sursa в part_size, от 5 МиБ до 100 МиБ; последняя часть может быть меньше |
| Число частей | До 1000 |
| Срок на завершение | 24 часа после создания загрузки |
| Срок на использование завершённой загрузки | 24 часа |
1. Создайте загрузку
POST /v1/uploads принимает имя, тип и размер файла, а также то, для чего вы
собираетесь его использовать:
FILE=training-video-transcripts.zip
SIZE=$(wc -c < "$FILE" | tr -d ' ')
curl -X POST https://api.sursa.com/v1/uploads \
-H "Authorization: Bearer $SURSA_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d "{\"filename\": \"$FILE\", \"content_type\": \"application/zip\", \"size\": $SIZE, \"purpose\": \"archive\"}"{
"id": "upl_5d3c2b1a0f9e8d7c6b5a493827161504",
"status": "pending",
"part_size": 8388608,
"part_count": 23,
"expires_at": "2026-10-25T10:00:00Z"
}
purpose | Для чего будет использована загрузка |
|---|---|
card_file | Для карточки: POST /v1/cards. |
archive | Для архива документов: POST /v1/cards/archive. |
import_attachment | Для файла документа своего источника, в upload_id или attachments. |
Ключу нужна область того места, куда пойдёт загрузка: cards:write для card_file и archive, import:write
для import_attachment.
Sursa выбирает part_size и сообщает, сколько частей отправить. Если SHA-256 файла известен заранее, его можно
передать и здесь, в sha256.
2. Отправьте части
Разрежьте файл на part_count кусков по part_size байт (последний — остаток) и отправьте каждый через
PUT /v1/uploads/{upload_id}/parts/{n}. Части нумеруются с 1. Тело запроса —
сырые байты части.
UPLOAD=upl_5d3c2b1a0f9e8d7c6b5a493827161504
split -b 8388608 -a 4 "$FILE" part-
n=1
for part in part-*; do
curl -X PUT "https://api.sursa.com/v1/uploads/$UPLOAD/parts/$n" \
-H "Authorization: Bearer $SURSA_API_KEY" \
-H "Content-Type: application/octet-stream" \
--data-binary "@$part" --retry 5 --fail
n=$((n + 1))
doneПовторная отправка части заменяет её, поэтому часть, которая не дошла или упала по тайм-ауту, просто отправляется ещё раз. Обычно до 4 частей параллельно полностью загружают быстрое соединение.
Проверка частей
Каждая часть идёт через API: прямых ссылок на хранилище нет. В ответе на часть есть заголовок ETag — SHA-256 части
в кавычках, и то же значение в поле etag тела JSON. GET /v1/uploads/{upload_id}
перечисляет в parts уже полученные части, поэтому после обрыва достаточно отправить только недостающие.
3. Завершите загрузку
POST /v1/uploads/{upload_id}/complete принимает SHA-256 всего файла в виде
64 шестнадцатеричных символов и, если нужно, etag каждой части в parts, чтобы проверить и части:
SHA=$(shasum -a 256 "$FILE" | cut -d' ' -f1)
curl -X POST "https://api.sursa.com/v1/uploads/$UPLOAD/complete" \
-H "Authorization: Bearer $SURSA_API_KEY" \
-H "Idempotency-Key: complete-$UPLOAD" \
-H "Content-Type: application/json" \
-d "{\"sha256\": \"$SHA\"}"Sursa собирает части, сравнивает хеш и проверяет файл так же, как любую загрузку: проверяет формат и, если это
включено, проверяет файл антивирусом. Ответ — 200, когда проверка завершена, и 202, пока она ещё идёт. Статус
загрузки переходит из processing в ready или в rejected с причиной в reject_reason. Читайте его через
GET /v1/uploads/{upload_id}.
4. Используйте загрузку
Передайте upload_id там, где отправили бы файл. Каждая загрузка используется один раз: после этого её
статус — consumed.
Для карточки и архива передайте upload_id в теле JSON вместо формы multipart/form-data. В таком теле коллекция
задаётся именем в поле collection.
# A card from the uploaded file
curl -X POST https://api.sursa.com/v1/cards \
-H "Authorization: Bearer $SURSA_API_KEY" \
-H "Idempotency-Key: card-from-$UPLOAD" \
-H "Content-Type: application/json" \
-d "{\"upload_id\": \"$UPLOAD\", \"collection\": \"support\", \"async\": true}"
# An archive of documents from the uploaded ZIP
curl -X POST https://api.sursa.com/v1/cards/archive \
-H "Authorization: Bearer $SURSA_API_KEY" \
-H "Idempotency-Key: archive-from-$UPLOAD" \
-H "Content-Type: application/json" \
-d "{\"upload_id\": \"$UPLOAD\", \"collection\": \"support\"}"Готовый загрузчик
import { createHash } from "node:crypto";
import { createReadStream } from "node:fs";
import { open, stat } from "node:fs/promises";
import { basename } from "node:path";
const BASE = "https://api.sursa.com";
const auth = { Authorization: `Bearer ${process.env.SURSA_API_KEY}` };
async function call(method, path, body, headers = {}) {
const isJson = body !== undefined && !(body instanceof Uint8Array);
const response = await fetch(BASE + path, {
method,
headers: { ...auth, ...(isJson ? { "Content-Type": "application/json" } : {}), ...headers },
body: isJson ? JSON.stringify(body) : body,
});
if (!response.ok) throw new Error(`${method} ${path}: HTTP ${response.status} ${await response.text()}`);
return response.json();
}
export async function uploadLargeFile(file, contentType, purpose, parallel = 4) {
const { size } = await stat(file);
const upload = await call("POST", "/v1/uploads",
{ filename: basename(file), content_type: contentType, size, purpose },
{ "Idempotency-Key": crypto.randomUUID() });
const hash = createHash("sha256");
for await (const block of createReadStream(file)) hash.update(block);
const handle = await open(file);
let next = 1;
async function worker() {
for (let n = next++; n <= upload.part_count; n = next++) {
const buffer = new Uint8Array(Math.min(upload.part_size, size - (n - 1) * upload.part_size));
await handle.read(buffer, 0, buffer.length, (n - 1) * upload.part_size);
for (let attempt = 1; ; attempt++) {
try {
await call("PUT", `/v1/uploads/${upload.id}/parts/${n}`, buffer, { "Content-Type": "application/octet-stream" });
break;
} catch (error) {
if (attempt === 5) throw error;
await new Promise((resolve) => setTimeout(resolve, 1000 * 2 ** attempt));
}
}
}
}
await Promise.all(Array.from({ length: parallel }, worker));
await handle.close();
await call("POST", `/v1/uploads/${upload.id}/complete`, { sha256: hash.digest("hex") },
{ "Idempotency-Key": `complete-${upload.id}` });
for (;;) {
const state = await call("GET", `/v1/uploads/${upload.id}`);
if (state.status === "ready") return upload.id;
if (state.status === "rejected") throw new Error(`upload rejected: ${state.reject_reason}`);
await new Promise((resolve) => setTimeout(resolve, 2000));
}
}Ошибки
| Код | Статус | Причина |
|---|---|---|
uploads.too_large | 413 | Файл больше 5 ГБ или больше всего хранилища по тарифу организации. |
limits.storage | 402 | В хранилище организации не хватает свободного места для файла. |
uploads.part_invalid | 400 | Номер части вне допустимого диапазона или размер части вне допустимых пределов. |
uploads.checksum_mismatch | 422 | SHA-256 собранного файла не совпадает с переданным. Какая-то часть повреждена или отсутствует: отправьте части ещё раз и снова завершите загрузку. |
uploads.not_ready | 409 | Загрузка ещё не завершена и не проверена. Дождитесь ready. |
uploads.already_used | 409 | Загрузка уже использована. Каждая загрузка используется один раз. |
uploads.expired | 410 | Прошло больше 24 часов. Создайте новую загрузку. |
uploads.rejected | 422 | Файл не прошёл проверки, например его формат не соответствует имени. Причина указана в сообщении. |
uploads.not_found | 404 | В организации нет такой загрузки. |