POST/v1/uploads

Започване на качване на части

create_upload

Отваря сесия за качване на голям файл (до лимита на инсталацията за качване на части, по подразбиране 5 GB): името, типът на съдържанието, размерът и purpose, което посочва какво ще използва качването: card_file (POST /v1/cards), archive (POST /v1/cards/archive) или import_attachment (прикачен файл към документ на собствен източник). Отговорът съдържа id (upl_, последвано от 32 шестнадесетични знака), размера на частта part_size и броя на частите part_count. Всяка част освен последната е точно part_size байта (от 5 до 100 MiB), а последната част е остатъкът. Незавършено качване съществува 24 часа (expires_at).

Разширение в името на файла извън форматите за предназначението връща 415 uploads.unsupported_format (прикаченият файл за импорт приема всяко разширение). Файл, по-голям от лимита на инсталацията или от общото хранилище на организацията по плана ѝ, връща 413 uploads.too_large. Недостатъчно оставащо място в хранилището, като се броят и незавършените качвания на организацията, връща 402 limits.storage.

Частите минават през Sursa (PUT /v1/uploads/{upload_id}/parts/{n}) и се шифрират с ключа на организацията във файловото хранилище; директни връзки към хранилището няма. Само API ключът или потребителят, създал качването, може да го вижда и използва. Добавено във версия 1.62.0.

Удостоверяване

Изпратете API ключ в заглавката Authorization: Authorization: Bearer <ключ>.

Параметри в заглавката

Idempotency-Keystring
Ключ за безопасен повторен опит при запис: от 1 до 255 печатаеми ASCII знака; препоръчва се UUID v4 за всяка логическа операция. Повторен опит със същия ключ в рамките на 24 часа не изпълнява операцията отново: връща записания отговор (статус, заглавки и тяло) със заглавката Idempotency-Replayed: true. Същият ключ с друг метод, път, Content-Type или тяло връща 409 api.idempotency_mismatch, а докато първата заявка още се изпълнява – 409 api.idempotency_in_progress с Retry-After: 1. След отговор 5xx или 429 ключът се освобождава и повторният опит изпълнява операцията отново. Ключът важи в рамките на организацията и извикващия (API ключ, потребител или ключ на собствен източник).
length ≥ 1, length ≤ 255

Тяло на заявката

application/json

Обект: UploadCreate

filenamestringзадължително
Името на файла с разширението му; разширението определя формата.
length ≥ 1, length ≤ 255
content_typestring
Декларираният тип на съдържанието (MIME); сравнява се със сигнатурата на файла.
length ≤ 255
sizeinteger (int64)задължително
Размерът на файла в байтове.
≥ 1
purposeUploadPurposeзадължително
sha256string
SHA-256 на файла, ако е известен предварително; complete сравнява контролната му сума с него.

Отговори

201Сесията за качване е създадена.

Заглавки на отговора

RateLimit-Policy
Действащите лимити във формата на черновата на IETF draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи "<name>";q=<quota>;w=<window in seconds>. key е честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия е user, без идентификационни данни – ip); minute, day и month са квотите на организацията за календарната минута, ден и месец по UTC.
RateLimit
Какво остава от всеки лимит в RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимитът на най-строгия запис в RateLimit-Policy (този с най-малко оставащи заявки).
X-RateLimit-Remaining
Оставащи заявки по най-строгия лимит.
X-RateLimit-Reset
Секунди до нулирането на най-строгия лимит.
Idempotency-Replayed
true означава, че отговорът е възпроизведен от записания за този Idempotency-Key: операцията не е изпълнена отново.

application/json

Обект: Upload

idstringзадължително
ID на качването (upl_, последвано от 32 шестнадесетични знака).
purposeUploadPurposeзадължително
filenamestringзадължително
Името на файла (без папки).
content_typestringзадължително
Декларираният тип на съдържанието; празно, ако не е деклариран.
sizeinteger (int64)задължително
Размерът на файла в байтове.
sha256string | nullзадължително
SHA-256 на файла, деклариран при създаването или при complete; null, ако още не е известен.
statusUploadStatusзадължително
part_sizeinteger (int64)задължително
Размерът на всяка част освен последната (от 5 до 100 MiB).
part_countintegerзадължително
Броят на частите.
≥ 1, ≤ 1000
parts_receivedintegerзадължително
Броят на получените части.
≥ 0
partsarray of UploadPartзадължително
Получените части по номер (празно в отговора на POST /v1/uploads).
reject_reasonstring | nullзадължително
Причина за отхвърлянето (rejected): checksum_mismatch, type_mismatch, unsupported_format, infected, scan_unavailable, unsafe_content. Изброяването може да се разширява; null, ако качването не е отхвърлено.
reject_detailsobject | nullзадължително
Подробности за отхвърлянето (разширението, декларираният и разпознатият формат, контролните суми); null, ако качването не е отхвърлено.
created_atstring (date-time)задължително
Кога е създадено качването.
expires_atstring (date-time)задължително
Крайният срок за завършване на качването и, след като е готово, за използването му.
completed_atstring (date-time) | nullзадължително
Кога е приключила проверката (ready или rejected).
consumed_atstring (date-time) | nullзадължително
Кога е използвано качването (от карта, архив или импорт).

401Не са изпратени идентификационни данни (нито бисквитка на сесията, нито API ключ) или ключът не е намерен.

Заглавки на отговора

RateLimit-Policy
Действащите лимити във формата на черновата на IETF draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи "<name>";q=<quota>;w=<window in seconds>. key е честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия е user, без идентификационни данни – ip); minute, day и month са квотите на организацията за календарната минута, ден и месец по UTC.
RateLimit
Какво остава от всеки лимит в RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимитът на най-строгия запис в RateLimit-Policy (този с най-малко оставащи заявки).
X-RateLimit-Remaining
Оставащи заявки по най-строгия лимит.
X-RateLimit-Reset
Секунди до нулирането на най-строгия лимит.

application/json

Обект: Error

402Организацията е достигнала лимит на плана (карти, хранилище или потребители). `error.details` съдържа `kind`, `limit` и `used`.

Заглавки на отговора

RateLimit-Policy
Действащите лимити във формата на черновата на IETF draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи "<name>";q=<quota>;w=<window in seconds>. key е честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия е user, без идентификационни данни – ip); minute, day и month са квотите на организацията за календарната минута, ден и месец по UTC.
RateLimit
Какво остава от всеки лимит в RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимитът на най-строгия запис в RateLimit-Policy (този с най-малко оставащи заявки).
X-RateLimit-Remaining
Оставащи заявки по най-строгия лимит.
X-RateLimit-Reset
Секунди до нулирането на най-строгия лимит.

application/json

Обект: Error

403Действието не е разрешено: ролята е недостатъчна, няма достъп до колекцията или картата, заявката се изпълнява в режим „View as“ или организацията е спряна или изтрита (`detail` е обект с `code: org_suspended | org_deleted`).

Заглавки на отговора

RateLimit-Policy
Действащите лимити във формата на черновата на IETF draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи "<name>";q=<quota>;w=<window in seconds>. key е честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия е user, без идентификационни данни – ip); minute, day и month са квотите на организацията за календарната минута, ден и месец по UTC.
RateLimit
Какво остава от всеки лимит в RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимитът на най-строгия запис в RateLimit-Policy (този с най-малко оставащи заявки).
X-RateLimit-Remaining
Оставащи заявки по най-строгия лимит.
X-RateLimit-Reset
Секунди до нулирането на най-строгия лимит.

application/json

Обект: Error

413Тялото на заявката надвишава допустимия размер.

Заглавки на отговора

RateLimit-Policy
Действащите лимити във формата на черновата на IETF draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи "<name>";q=<quota>;w=<window in seconds>. key е честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия е user, без идентификационни данни – ip); minute, day и month са квотите на организацията за календарната минута, ден и месец по UTC.
RateLimit
Какво остава от всеки лимит в RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимитът на най-строгия запис в RateLimit-Policy (този с най-малко оставащи заявки).
X-RateLimit-Remaining
Оставащи заявки по най-строгия лимит.
X-RateLimit-Reset
Секунди до нулирането на най-строгия лимит.

application/json

Обект: Error

415Форматът на файла не се поддържа.

Заглавки на отговора

RateLimit-Policy
Действащите лимити във формата на черновата на IETF draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи "<name>";q=<quota>;w=<window in seconds>. key е честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия е user, без идентификационни данни – ip); minute, day и month са квотите на организацията за календарната минута, ден и месец по UTC.
RateLimit
Какво остава от всеки лимит в RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимитът на най-строгия запис в RateLimit-Policy (този с най-малко оставащи заявки).
X-RateLimit-Remaining
Оставащи заявки по най-строгия лимит.
X-RateLimit-Reset
Секунди до нулирането на най-строгия лимит.

application/json

Обект: Error

422Грешка при валидиране: тялото или параметрите не съответстват на схемата (`detail` е списък с грешки при валидиране) или стойност на параметър е извън допустимия диапазон (`detail` е съобщение).

Заглавки на отговора

RateLimit-Policy
Действащите лимити във формата на черновата на IETF draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи "<name>";q=<quota>;w=<window in seconds>. key е честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия е user, без идентификационни данни – ip); minute, day и month са квотите на организацията за календарната минута, ден и месец по UTC.
RateLimit
Какво остава от всеки лимит в RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимитът на най-строгия запис в RateLimit-Policy (този с най-малко оставащи заявки).
X-RateLimit-Remaining
Оставащи заявки по най-строгия лимит.
X-RateLimit-Reset
Секунди до нулирането на най-строгия лимит.

application/json

Обект: Error

429Твърде много заявки (`api.rate_limited`), квотата на организацията за минутата, деня или месеца е изчерпана (`api.quota_exceeded`; `error.details` съдържа `quota`, `limit` и `reset_at`), достигнат е лимит на организацията или услугата за отговори е заета (`answers.engine_busy`). Изчакайте времето от заглавката `Retry-After`.

Заглавки на отговора

Retry-After
Брой секунди, които да изчакате, преди да повторите заявката.
RateLimit-Policy
Действащите лимити във формата на черновата на IETF draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи "<name>";q=<quota>;w=<window in seconds>. key е честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия е user, без идентификационни данни – ip); minute, day и month са квотите на организацията за календарната минута, ден и месец по UTC.
RateLimit
Какво остава от всеки лимит в RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимитът на най-строгия запис в RateLimit-Policy (този с най-малко оставащи заявки).
X-RateLimit-Remaining
Оставащи заявки по най-строгия лимит.
X-RateLimit-Reset
Секунди до нулирането на най-строгия лимит.

application/json

Обект: Error

Кодове на грешки

Кодове, които тази операция може да върне в error.code, освен общите кодове на всяка заявка.

Безопасни повторни опити

Изпращайте заглавката Idempotency-Key (например UUID) с всяка заявка POST и PATCH. Повторен опит със същия ключ в рамките на 24 часа връща запазения отговор, вместо да изпълни заявката отново.

Лимити на честотата

Отговорите съдържат заглавките RateLimit и RateLimit-Policy, както и по-ранните X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset. Отговорът 429 съдържа Retry-After в секунди: изчакайте и опитайте отново.

← uploads · Справочник на API

curl -X POST 'https://api.sursa.com/v1/uploads' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"filename":"document.pdf","size":1,"purpose":"card_file"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Изпробвайте

API ключ

Ключът остава само в паметта на този раздел на браузъра и се изпраща единствено до https://api.sursa.com.

Заявките работят с реалните данни на организацията ви.

Idempotency-Key header

Idempotency-Key

Ако полето е празно, за всяка заявка се генерира нов ключ.

Тяло на заявката (JSON)