POST/v1/cards

Nahrať súbor ako kartu

upload_card

Pošlite dokument v poli file formulára multipart/form-data. Pred uložením Sursa skontroluje, či sa zhodujú prípona názvu súboru, deklarovaný Content-Type časti a signatúra obsahu:
- PDF;
- DOCX, XLSX, XLSM, PPTX: ZIP s deklarovaným typom hlavného dokumentu;
- ODS: ZIP s položkou mimetype;
- XLS: dokument OLE2 so streamom zošita;
- TXT, MD, CSV, TSV, HTML, AsciiDoc, EML: text bez nulových bajtov v UTF-8 alebo v jednobajtovom kódovaní a pri e-mailoch hlavičky na začiatku;
- PNG, JPEG, TIFF, WebP, BMP: podľa signatúry.

Nezhoda vráti 415 files.type_mismatch; prípona mimo zoznamu formátov vráti 415 cards.unsupported_format. Súbor väčší ako limit nahrávania inštalácie alebo ako celkové úložisko organizácie podľa jej tarify vráti 413 files.too_large. Ak je zapnutá antivírusová kontrola, infikovaný súbor vráti 422 files.infected, a ak je antivírusový skener pri politike „reject“ nedostupný, požiadavka vráti 503 files.scan_unavailable. Každé odmietnutie sa zapíše do auditného logu ako file.rejected.

Namiesto formulára môžete poslať telo application/json (CardUploadFromUpload, od verzie 1.62.0): súborom je hotové viacdielne nahrávanie upload_id (POST /v1/uploads s účelom card_file), polia sú rovnaké ako vo formulári a tags je pole JSON reťazcov. Súbor nahrávania bol skontrolovaný už pri complete (formát, antivírus) a limitom veľkosti je limit viacdielneho nahrávania namiesto limitu nahrávania jednou požiadavkou. Nahrávanie sa použije raz, v tej istej transakcii, ktorá vytvára kartu: už použité nahrávanie vráti 409 uploads.already_used, ešte nepripravené 409 uploads.not_ready, odmietnuté 422 uploads.rejected, nahrávanie s iným účelom 422 uploads.purpose_mismatch, nahrávanie s vypršanou platnosťou 410 uploads.expired a nahrávanie iného volajúceho alebo neznáme nahrávanie 404 uploads.not_found. Ak kontroly karty zlyhajú (kolekcia, kategória, limity), nahrávanie sa nespotrebuje.

Autentifikácia

Odošlite kľúč API v hlavičke Authorization: Authorization: Bearer <kľúč>.

Parametre hlavičky

Idempotency-Keystring
Kľúč na bezpečné opakovanie zápisu: 1 až 255 tlačiteľných znakov ASCII; odporúča sa UUID v4 pre každú logickú operáciu. Opakovanie s tým istým kľúčom do 24 hodín operáciu znova nespustí: vráti uloženú odpoveď (stav, hlavičky a telo) s hlavičkou Idempotency-Replayed: true. Ten istý kľúč s inou metódou, cestou, Content-Type alebo telom vráti 409 api.idempotency_mismatch; kým prvá požiadavka ešte prebieha, vráti 409 api.idempotency_in_progress s Retry-After: 1. Po odpovedi 5xx alebo 429 sa kľúč uvoľní a opakovanie operáciu spustí znova. Kľúč platí v rámci organizácie a volajúceho (kľúč API, používateľ alebo kľúč vlastného zdroja).
length ≥ 1, length ≤ 255
X-View-Asstring
Len pre kľúče API s rolou admin. Vykoná požiadavku v mene dátového profilu <profile>[:viewer|verifier|editor], napríklad employee:viewer. Inštalačný kľúč túto hlavičku použiť nemôže (403).

Parametre cookie

kb_view_asstring
Súbor cookie režimu „View as“ pre reláciu. POST /auth/view-as ho nastaví a DELETE /auth/view-as ho odstráni.

Telo požiadavky

multipart/form-data

Objekt: CardUploadForm

filestring (application/octet-stream)povinné
collectionstring
Predvolené: "default"
tagsstring
Predvolené: ""
forceboolean
Predvolené: false
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
asyncboolean
Predvolené: false
reviewboolean
Predvolené: false
folder_idstring | null
Priečinok kolekcie collection, do ktorého sa vloží nová karta. Priečinok inej kolekcie vráti 400 folders.card_collection_mismatch, neexistujúci priečinok vráti 404 folders.not_found a chýbajúce oprávnenie COLLECTION_EDIT_CARDS na priečinok vráti 403 authz.forbidden. Kontrola prebehne pred uložením súboru. Duplikát už nahratého súboru (skipped) sa do priečinka nepresunie.
length ≤ 64
collection_idinteger | null
Kolekcia podľa ID. Ak sa odovzdá aj collection, prednosť má collection_id. Kolekcia, ktorá v organizácii neexistuje alebo nie je viditeľná, vráti 404 collections.not_found.
external_idstring | null
external_id novej karty. S ním sa karta vytvorí, aj keď kolekcia už rovnaký súbor obsahuje. Ak ho používa iná karta organizácie, požiadavka vráti 409 cards.external_id_taken. Ak chcete kartu vytvoriť alebo nahradiť podľa external_id, použite PUT /v1/cards-by-external-id/{external_id}.
length ≤ 512
metadatastring | null
metadata novej karty: objekt JSON ako hodnota poľa formulára. Platia pravidlá MetadataPatch.

application/json

Objekt: CardUploadFromUpload

upload_idstringpovinné
Pripravené nahrávanie (ready) s účelom card_file; použije sa raz.
collectionstring
Predvolené: "default"
collection_idinteger | null
Kolekcia podľa ID. Ak sa odovzdá aj collection, prednosť má collection_id. Kolekcia, ktorá v organizácii neexistuje, nie je viditeľná alebo je mimo kolekcií kľúča, vráti 404 collections.not_found.
tagsarray of string
items ≤ 30
forceboolean
Predvolené: false
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
asyncboolean
Predvolené: false
reviewboolean
Predvolené: false
folder_idstring | null
length ≤ 64
external_idstring | null
external_id novej karty, rovnako ako v poli formulára. S ním sa karta vytvorí, aj keď kolekcia už má rovnaký súbor. Ak ho používa iná karta organizácie, požiadavka vráti 409 cards.external_id_taken.
length ≤ 512
metadataMetadataPatch

Odpovede

200`queued` (asynchrónne), `skipped` (duplicita), `ready` alebo `error` (synchrónne).

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.
Idempotency-Replayed
true znamená, že odpoveď bola zopakovaná z uloženej odpovede pre tento Idempotency-Key: operácia sa znova nespustila.

application/json

Objekt: UploadResult

statusstringpovinné
Povolené hodnoty: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged alebo an identical file is already indexed.
tablesinteger
timingsobject
Polia
- total_snumber
errorstring

400Požiadavka je neplatná: hodnota parametra alebo stav objektu akciu nedovoľuje (`detail` je správa).

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

401Neboli odoslané žiadne prihlasovacie údaje (ani cookie relácie, ani kľúč API) alebo sa kľúč nenašiel.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

402Organizácia dosiahla limit tarify (karty, úložisko alebo používatelia). `error.details` obsahuje `kind`, `limit` a `used`.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

403Akcia nie je povolená: rola nestačí, chýba prístup ku kolekcii alebo karte, požiadavka beží v režime „View as“ alebo je organizácia pozastavená či odstránená (`detail` je objekt s `code: org_suspended | org_deleted`).

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

404Objekt neexistuje alebo vám nie je dostupný. API nepotvrdzuje, že objekt s obmedzeným prístupom existuje.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

409Stav objektu akciu nedovoľuje, napríklad duplicita, prebiehajúce indexovanie alebo úloha, ktorá je už spracovaná.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

410Objekt existoval, ale už nie je dostupný: odkaz bol použitý alebo mu vypršala platnosť, prípadne bol súbor odstránený na konci doby uchovávania.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

413Telo požiadavky presahuje povolenú veľkosť.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

415Formát súboru nie je podporovaný.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

422Chyba validácie: telo alebo parametre nezodpovedajú schéme (`detail` je zoznam chýb validácie) alebo je hodnota parametra mimo rozsahu (`detail` je správa).

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

429Príliš veľa požiadaviek (`api.rate_limited`), vyčerpaná kvóta organizácie na minútu, deň alebo mesiac (`api.quota_exceeded`; `error.details` obsahuje `quota`, `limit` a `reset_at`), dosiahnutý limit organizácie alebo zaneprázdnená služba odpovedí (`answers.engine_busy`). Počkajte čas uvedený v hlavičke `Retry-After`.

Hlavičky odpovede

Retry-After
Počet sekúnd, ktoré treba počkať pred opakovaním požiadavky.
RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

503Služba, od ktorej táto požiadavka závisí, je dočasne nedostupná. Skúste to znova neskôr.

Hlavičky odpovede

RateLimit-Policy
Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.
RateLimit
Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).
X-RateLimit-Remaining
Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-Reset
Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

Chybové kódy

Kódy, ktoré táto operácia môže vrátiť v error.code, okrem všeobecných kódov každej požiadavky.

Bezpečné opakovanie

S každou požiadavkou POST a PATCH odošlite hlavičku Idempotency-Key (napríklad UUID). Opakovaná požiadavka s rovnakým kľúčom do 24 hodín vráti uloženú odpoveď namiesto toho, aby sa požiadavka vykonala znova.

Limity frekvencie

Odpovede obsahujú hlavičky RateLimit a RateLimit-Policy a staršie X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Odpoveď 429 má hlavičku Retry-After v sekundách: počkajte a požiadavku zopakujte.

← cards · Referencia API

curl -X POST 'https://api.sursa.com/v1/cards' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"upload_id":"upl_0123456789abcdef0123456789abcdef"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Vyskúšať

Kľúč API

Kľúč zostáva v pamäti tejto karty prehliadača a odosiela sa len na https://api.sursa.com.

Požiadavky pracujú so skutočnými údajmi vašej organizácie.

Idempotency-Key header

X-View-As header

Idempotency-Key

Ak je pole prázdne, pre každú požiadavku sa vygeneruje nový kľúč.

Telo požiadavky (JSON)