Preskočiť na obsah
Sursa Developers

Nahrajte veľké súbory

Súbor možno poslať v jednej požiadavke POST /v1/cards až do limitu nahrávania inštalácie (predvolene 200 MB). Nad touto hranicou alebo v sieti, kde sa dlhá požiadavka pravdepodobne preruší, nahrajte súbor po častiach:

  1. Vytvorte nahrávanie: povedzte Surse názov, typ a veľkosť súboru.
  2. Odošlite časti, v ľubovoľnom poradí a podľa potreby aj súbežne. Neúspešnú časť odošlete znova samostatne.
  3. Dokončite nahrávanie s hodnotou SHA-256 celého súboru. Sursa súbor poskladá a overí.
  4. ID nahrávania použite namiesto súboru: pre kartu, archív alebo dokument vlastného zdroja.
LimitHodnota
Veľkosť súboruNajviac 5 GB
Veľkosť častiVolí ju Sursa v part_size, od 5 MiB do 100 MiB; posledná časť môže byť menšia
Počet častíNajviac 1000
Čas na dokončenie24 hodín od vytvorenia nahrávania
Čas na použitie dokončeného nahrávania24 hodín

1. Vytvorte nahrávanie

POST /v1/uploads prijíma názov, typ a veľkosť súboru a to, na čo ho použijete:

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"
}
purposeNahrávanie sa použije pre
card_fileKartu: POST /v1/cards.
archiveArchív dokumentov: POST /v1/cards/archive.
import_attachmentSúbor dokumentu vlastného zdroja v upload_id alebo attachments.

Kľúč potrebuje rozsah miesta, kam nahrávanie smeruje: cards:write pre card_file a archive, import:write pre import_attachment.

Sursa zvolí part_size a povie vám, koľko častí máte poslať. Ak hodnotu SHA-256 súboru poznáte vopred, môžete ju odoslať ako sha256 už tu.

2. Odošlite časti

Rozdeľte súbor na part_count kusov s veľkosťou part_size bajtov (posledný je zvyšok) a každý odošlite cez PUT /v1/uploads/{upload_id}/parts/{n}. Časti sa číslujú od 1. Telo tvoria surové bajty časti.

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

Opätovné odoslanie časti ju nahradí, takže časť, ktorá zlyhala alebo pri ktorej vypršal časový limit, jednoducho odošlete znova. Rýchle pripojenie zvyčajne naplno vyťažia najviac 4 časti súbežne.

Skontrolujte časti

Každá časť ide cez API: priame odkazy do úložiska neexistujú. Odpoveď na časť má hlavičku ETag s hodnotou SHA-256 časti v úvodzovkách a tú istú hodnotu v etag tela JSON. GET /v1/uploads/{upload_id} uvádza v parts doteraz prijaté časti, takže po prerušení odošlete len chýbajúce.

3. Dokončite nahrávanie

POST /v1/uploads/{upload_id}/complete prijíma hodnotu SHA-256 celého súboru ako 64 šestnástkových znakov a voliteľne aj etag každej časti v parts, aby sa skontrolovali aj časti:

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 poskladá časti, porovná hash a súbor skontroluje ako pri každom nahrávaní: overí jeho formát a tam, kde je to zapnuté, ho preverí antivírusom. Odpoveď je 200, keď je kontrola hotová, a 202, kým ešte prebieha. Stav nahrávania prejde z processing na ready alebo na rejected s dôvodom v reject_reason. Prečítate ho cez GET /v1/uploads/{upload_id}.

4. Použite nahrávanie

upload_id odošlite tam, kam by ste poslali súbor. Každé nahrávanie sa použije raz: potom má stav consumed.

Pre kartu a archív odošlite upload_id v tele JSON namiesto formulára multipart/form-data. Toto telo prijíma kolekciu podľa jej názvu v 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\"}"

Úplný nahrávací program

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));
  }
}

Chyby

KódStavPríčina
uploads.too_large413Súbor je väčší ako 5 GB alebo väčší ako celé úložisko tarify organizácie.
limits.storage402Organizácii nezostáva pre súbor dosť voľného úložiska.
uploads.part_invalid400Číslo časti mimo rozsahu alebo časť mimo povolenej veľkosti.
uploads.checksum_mismatch422Hodnota SHA-256 poskladaného súboru nie je tá, ktorú ste odoslali. Niektorá časť sa poškodila alebo chýba: odošlite časti znova a nahrávanie znova dokončite.
uploads.not_ready409Nahrávanie ešte nie je dokončené a overené. Počkajte na ready.
uploads.already_used409Nahrávanie už bolo použité. Každé nahrávanie sa použije raz.
uploads.expired410Uplynulo viac ako 24 hodín. Vytvorte nové nahrávanie.
uploads.rejected422Súbor neprešiel kontrolami, napríklad jeho formát nezodpovedá názvu. Dôvod uvádza správa.
uploads.not_found404Takéto nahrávanie v organizácii neexistuje.