Didelių failų įkėlimas
Failą galima išsiųsti viena POST /v1/cards užklausa, kol jis neviršija diegimo
įkėlimo limito (numatytoji reikšmė – 200 MB). Didesnį failą arba tada, kai tinkle ilga užklausa greičiausiai
nutrūktų, įkelkite dalimis:
- Sukurkite įkėlimą: nurodykite Sursai failo pavadinimą, tipą ir dydį.
- Siųskite dalis bet kokia tvarka, jei norite – lygiagrečiai. Nepavykusi dalis siunčiama dar kartą atskirai.
- Užbaikite įkėlimą su viso failo SHA-256. Sursa surenka failą ir jį patikrina.
- Vietoj failo naudokite įkėlimo ID: kortelei, archyvui ar pasirinktinio šaltinio dokumentui.
| Limitas | Reikšmė |
|---|---|
| Failo dydis | Iki 5 GB |
| Dalies dydis | Parenka Sursa lauke part_size, nuo 5 MiB iki 100 MiB; paskutinė dalis gali būti mažesnė |
| Dalių skaičius | Iki 1000 |
| Laikas užbaigti | 24 valandos nuo įkėlimo sukūrimo |
| Laikas panaudoti užbaigtą įkėlimą | 24 valandos |
1. Sukurkite įkėlimą
POST /v1/uploads priima failo pavadinimą, tipą, dydį ir tai, kam ketinate jį
naudoti:
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 | Įkėlimas bus naudojamas |
|---|---|
card_file | Kortelei: POST /v1/cards. |
archive | Dokumentų archyvui: POST /v1/cards/archive. |
import_attachment | Pasirinktinio šaltinio dokumento failui, lauke upload_id arba attachments. |
Raktui reikia vietos, į kurią eina įkėlimas, apimties: cards:write – card_file ir archive, import:write –
import_attachment.
Sursa parenka part_size ir nurodo, kiek dalių siųsti. Jei viso failo SHA-256 žinote iš anksto, galite jį perduoti ir
čia, lauke sha256.
2. Siųskite dalis
Supjaustykite failą į part_count dalis po part_size baitų (paskutinė – likutis) ir kiekvieną siųskite
PUT /v1/uploads/{upload_id}/parts/{n}. Dalys numeruojamos nuo 1. Turinys –
neapdoroti dalies baitai.
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))
doneDar kartą išsiųsta dalis pakeičia ankstesnę, todėl nepavykusi ar laiko limitą viršijusi dalis tiesiog siunčiama dar kartą. Greito ryšio pralaidumui išnaudoti paprastai pakanka iki 4 lygiagrečių dalių.
Dalių patikrinimas
Kiekviena dalis siunčiama per API: tiesioginių nuorodų į saugyklą nėra. Atsakas į dalį turi antraštę ETag – dalies
SHA-256 kabutėse – ir tą pačią reikšmę JSON turinio lauke etag.
GET /v1/uploads/{upload_id} lauke parts išvardija iki šiol gautas dalis, todėl
nutrūkus ryšiui siunčiate tik trūkstamas.
3. Užbaikite įkėlimą
POST /v1/uploads/{upload_id}/complete priima viso failo SHA-256 kaip 64
šešioliktainius simbolius ir, jei norite patikrinti ir dalis, kiekvienos dalies etag lauke 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 surenka dalis, palygina maišos reikšmę ir patikrina failą taip pat, kaip bet kurį įkėlimą: jo formatą ir, jei
įjungta, antivirusinę patikrą. Atsakas yra 200, kai patikra baigta, ir 202, kol ji dar vyksta. Įkėlimo būsena
keičiasi iš processing į ready arba į rejected su priežastimi lauke reject_reason. Ją nuskaitykite operacija
GET /v1/uploads/{upload_id}.
4. Panaudokite įkėlimą
Perduokite upload_id ten, kur kitu atveju siųstumėte failą. Kiekvienas įkėlimas naudojamas vieną kartą: po to jo
būsena yra consumed.
Kortelei ir archyvui upload_id siųskite JSON turinyje, o ne multipart/form-data formoje. Šiame turinyje rinkinys
nurodomas pavadinimu lauke 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\"}"Visas įkėlimo įrankis
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));
}
}Klaidos
| Kodas | Būsena | Priežastis |
|---|---|---|
uploads.too_large | 413 | Failas didesnis nei 5 GB arba didesnis už visą organizacijos plano saugyklą. |
limits.storage | 402 | Organizacijai neliko pakankamai laisvos saugyklos vietos šiam failui. |
uploads.part_invalid | 400 | Dalies numeris už leistino intervalo arba dalies dydis už leistinų ribų. |
uploads.checksum_mismatch | 422 | Surinkto failo SHA-256 nesutampa su jūsų išsiųstuoju. Dalis buvo sugadinta arba jos trūksta: išsiųskite dalis dar kartą ir vėl užbaikite įkėlimą. |
uploads.not_ready | 409 | Įkėlimas dar neužbaigtas ir nepatikrintas. Palaukite ready. |
uploads.already_used | 409 | Įkėlimas jau panaudotas. Kiekvienas įkėlimas naudojamas vieną kartą. |
uploads.expired | 410 | Praėjo daugiau nei 24 valandos. Sukurkite naują įkėlimą. |
uploads.rejected | 422 | Failas nepraėjo patikrų, pavyzdžiui, jo formatas neatitinka pavadinimo. Priežastį nurodo pranešimas. |
uploads.not_found | 404 | Organizacijoje tokio įkėlimo nėra. |