POST/v1/cards

Încarcă un fișier ca fișă

upload_card

Trimiteți documentul în câmpul file al unui formular multipart/form-data. Înainte de salvare, Sursa verifică dacă extensia numelui fișierului, Content-Type declarat al părții și semnătura conținutului concordă:
- PDF;
- DOCX, XLSX, XLSM, PPTX: o arhivă ZIP cu tipul declarat al documentului principal;
- ODS: o arhivă ZIP cu o intrare mimetype;
- XLS: un document OLE2 cu fluxul registrului de lucru;
- TXT, MD, CSV, TSV, HTML, AsciiDoc, EML: text fără octeți nuli, în UTF-8 sau într-o codificare pe un singur octet, iar pentru e-mail – antete la început;
- PNG, JPEG, TIFF, WebP, BMP: după semnătură.

O nepotrivire returnează 415 files.type_mismatch; o extensie din afara listei de formate returnează 415 cards.unsupported_format. Un fișier mai mare decât limita de încărcare a instalării sau decât spațiul de stocare total al organizației conform planului returnează 413 files.too_large. Când scanarea antivirus este activată, un fișier infectat returnează 422 files.infected, iar dacă scanerul nu este disponibil și se aplică politica „reject”, cererea returnează 503 files.scan_unavailable. Fiecare respingere este înregistrată în jurnalul de audit ca file.rejected.

În locul formularului, puteți trimite un corp application/json (CardUploadFromUpload, începând cu 1.62.0): fișierul este o încărcare în părți gata finalizată, upload_id (POST /v1/uploads cu scopul card_file), câmpurile sunt aceleași ca în formular, iar tags este o listă de șiruri. Fișierul încărcării a fost deja verificat la complete (format, antivirus), iar limita de dimensiune este cea a încărcării în părți, nu cea a încărcării într-o singură cerere. Încărcarea se folosește o singură dată, în aceeași tranzacție care creează fișa: o încărcare deja folosită returnează 409 uploads.already_used, una care nu este încă gata returnează 409 uploads.not_ready, una respinsă returnează 422 uploads.rejected, una cu alt scop returnează 422 uploads.purpose_mismatch, una expirată returnează 410 uploads.expired, iar încărcarea altui apelant sau una necunoscută returnează 404 uploads.not_found. Dacă verificările fișei eșuează (colecție, categorie, limite), încărcarea nu este consumată.

Autentificare

Trimiteți o cheie API în antetul Authorization: Authorization: Bearer <cheie>.

Parametri de antet

Idempotency-Keystring
Cheie pentru reîncercarea sigură a unei scrieri: 1–255 de caractere ASCII imprimabile; se recomandă un UUID v4 pentru fiecare operație logică. O reîncercare cu aceeași cheie în decurs de 24 de ore nu execută din nou operația: returnează răspunsul salvat (status, antete și corp) cu antetul Idempotency-Replayed: true. Aceeași cheie cu altă metodă, altă cale, alt Content-Type sau alt corp returnează 409 api.idempotency_mismatch; cât timp prima cerere încă rulează – 409 api.idempotency_in_progress cu Retry-After: 1. După un răspuns 5xx sau 429, cheia este eliberată, iar o reîncercare execută din nou operația. Cheia este valabilă în cadrul organizației și al apelantului (cheie API, utilizator sau cheie de sursă personalizată).
length ≥ 1, length ≤ 255
X-View-Asstring
Doar pentru cheile API cu rolul admin. Execută cererea cu profilul de date <profile>[:viewer|verifier|editor], de exemplu employee:viewer. Cheia de instalare nu poate folosi acest antet (403).

Parametri cookie

kb_view_asstring
Cookie-ul modului „View as” (vizualizare ca alt utilizator) pentru o sesiune. POST /auth/view-as îl setează, iar DELETE /auth/view-as îl șterge.

Corpul cererii

multipart/form-data

Obiect: CardUploadForm

filestring (application/octet-stream)obligatoriu
collectionstring
Implicit: "default"
tagsstring
Implicit: ""
forceboolean
Implicit: false
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
asyncboolean
Implicit: false
reviewboolean
Implicit: false
folder_idstring | null
Dosarul din collection în care se pune noua fișă. Un dosar din altă colecție returnează 400 folders.card_collection_mismatch, un dosar inexistent returnează 404 folders.not_found, iar lipsa permisiunii COLLECTION_EDIT_CARDS pe dosar returnează 403 authz.forbidden. Verificarea are loc înainte de salvarea fișierului. Un duplicat al unui fișier deja încărcat (skipped) nu se mută în dosar.
length ≤ 64
collection_idinteger | null
Colecția după ID. Când se transmite și collection, are prioritate collection_id. O colecție care nu există în organizație sau nu este vizibilă returnează 404 collections.not_found.
external_idstring | null
external_id al noii fișe. Cu el, fișa se creează chiar dacă colecția are deja același fișier. Dacă îl folosește o altă fișă a organizației, cererea returnează 409 cards.external_id_taken. Pentru a crea sau a înlocui o fișă după external_id, folosiți PUT /v1/cards-by-external-id/{external_id}.
length ≤ 512
metadatastring | null
metadata ale noii fișe: un obiect JSON ca valoare a câmpului din formular. Regulile sunt cele din MetadataPatch.

application/json

Obiect: CardUploadFromUpload

upload_idstringobligatoriu
O încărcare gata (ready) cu scopul card_file; se folosește o singură dată.
collectionstring
Implicit: "default"
collection_idinteger | null
Colecția după ID. Când se transmite și collection, are prioritate collection_id. O colecție care nu există în organizație, nu este vizibilă sau se află în afara colecțiilor cheii returnează 404 collections.not_found.
tagsarray of string
items ≤ 30
forceboolean
Implicit: false
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
asyncboolean
Implicit: false
reviewboolean
Implicit: false
folder_idstring | null
length ≤ 64
external_idstring | null
external_id al fișei noi, ca în câmpul formularului. Cu el, fișa este creată chiar dacă colecția are deja același fișier. Dacă o altă fișă a organizației îl folosește, cererea returnează 409 cards.external_id_taken.
length ≤ 512
metadataMetadataPatch

Răspunsuri

200`queued` (asincron), `skipped` (dublură), `ready` sau `error` (sincron).

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.
Idempotency-Replayed
true înseamnă că răspunsul a fost redat din cel salvat pentru această cheie Idempotency-Key: operația nu a rulat din nou.

application/json

Obiect: UploadResult

statusstringobligatoriu
Valori permise: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged sau an identical file is already indexed.
tablesinteger
timingsobject
Câmpuri
- total_snumber
errorstring

400Cererea este invalidă: valoarea unui parametru sau starea obiectului nu permite acțiunea (`detail` este un mesaj).

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

401Nu au fost trimise date de autentificare (nici cookie de sesiune, nici cheie API) sau cheia nu a fost găsită.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

402Organizația a atins o limită a planului (fișe, spațiu de stocare sau utilizatori). `error.details` conține `kind`, `limit` și `used`.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

403Acțiunea nu este permisă: rolul este insuficient, nu există acces la colecție sau la fișă, cererea rulează în modul „View as” (vizualizare ca alt utilizator) sau organizația este suspendată ori ștearsă (`detail` este un obiect cu `code: org_suspended | org_deleted`).

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

404Obiectul nu există sau nu vă este disponibil. API-ul nu confirmă existența unui obiect restricționat.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

409Starea obiectului nu permite acțiunea, de exemplu o dublură, o indexare în curs sau un job deja procesat.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

410Obiectul a existat, dar nu mai este disponibil: linkul a fost folosit sau a expirat ori fișierul a fost șters la sfârșitul perioadei de păstrare.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

413Corpul cererii depășește dimensiunea permisă.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

415Formatul fișierului nu este acceptat.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

422Eroare de validare: corpul sau parametrii nu corespund schemei (`detail` este o listă de erori de validare) ori valoarea unui parametru este în afara intervalului permis (`detail` este un mesaj).

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

429Prea multe cereri (`api.rate_limited`), cota organizației pentru minut, zi sau lună este epuizată (`api.quota_exceeded`; `error.details` conține `quota`, `limit` și `reset_at`), limita organizației este atinsă sau serviciul de răspunsuri este ocupat (`answers.engine_busy`). Așteptați timpul indicat în antetul `Retry-After`.

Antetele răspunsului

Retry-After
Numărul de secunde de așteptat înainte de a reîncerca cererea.
RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

503Un serviciu de care depinde această cerere este temporar indisponibil. Reîncercați mai târziu.

Antetele răspunsului

RateLimit-Policy
Limitele în vigoare, în formatul proiectului IETF draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă "<name>";q=<quota>;w=<window in seconds>. key este frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune este user, fără date de autentificare ip); minute, day și month sunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.
RateLimit
Cât a rămas din fiecare limită din RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Limita celei mai stricte intrări din RateLimit-Policy (cea cu cele mai puține cereri rămase).
X-RateLimit-Remaining
Cereri rămase în cadrul celei mai stricte limite.
X-RateLimit-Reset
Secunde până la resetarea celei mai stricte limite.

application/json

Obiect: Error

Coduri de eroare

Codurile pe care acest endpoint le poate returna în error.code, pe lângă codurile generale ale oricărei cereri.

Reîncercări sigure

Trimiteți un antet Idempotency-Key (de exemplu, un UUID) cu fiecare POST și PATCH. O reîncercare cu aceeași cheie în decurs de 24 de ore returnează răspunsul salvat, fără să execute din nou cererea.

Limite de frecvență

Răspunsurile conțin antetele RateLimit și RateLimit-Policy, precum și antetele anterioare X-RateLimit-Limit, X-RateLimit-Remaining și X-RateLimit-Reset. Un răspuns 429 conține Retry-After în secunde: așteptați și reîncercați.

← cards · Referința 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"

Încercați

Cheie API

Cheia rămâne în memoria acestei file a browserului și este trimisă doar către https://api.sursa.com.

Cererile se execută pe datele reale ale organizației.

Idempotency-Key header

X-View-As header

Idempotency-Key

Dacă acest câmp este gol, pentru fiecare cerere se generează o cheie nouă.

Corpul cererii (JSON)