Завантажуйте великі файли
Файл можна надіслати одним запитом POST /v1/cards, якщо він не перевищує ліміту
завантаження інсталяції (типово 200 МБ). Файли, більші за цей ліміт, а також файли в мережі, де довгий запит,
найімовірніше, обірветься, завантажуйте частинами:
- Створіть завантаження: повідомте Sursa назву, тип і розмір файлу.
- Надішліть частини — у будь-якому порядку й за бажання паралельно. Частину, яку не вдалося надіслати, надсилають повторно окремо.
- Завершіть завантаження, передавши SHA-256 усього файлу. Sursa збирає файл і перевіряє його.
- Використайте ID завантаження замість файлу: для картки, архіву або документа власного джерела.
| Ліміт | Значення |
|---|---|
| Розмір файлу | До 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 | В організації немає такого завантаження. |