PUT/v1/cards-by-external-id/{external_id}

Kártya létrehozása vagy cseréje külső azonosító alapján

upsert_card_by_external_id

Létrehoz vagy lecserél egy kártyát az integrátor external_id azonosítója alapján. Szöveget application/json formában (CardTextUpsert), fájlt multipart/form-data formában küldj (CardFileUpsertForm, ugyanazokkal a fájlellenőrzésekkel, mint a POST /v1/cards esetén). Ha a szervezetben nincs ilyen external_id azonosítójú kártya, a kártya a törzsben megadott gyűjteményben és mappában jön létre (201). Ellenkező esetben a tartalom új verzióra cserélődik, és ugyanúgy újra indexelődik, mint egy fájl új verziója, a kártya adatai (cím, címkék, felelős, kategória, metadata) pedig a megadott értékeket veszik fel (200). A változatlan tartalom nem hoz létre új verziót (status: skipped, reason: unchanged), így a kérés megismétlése Idempotency-Key nélkül is biztonságos. Ha a metadata meg van adva, a teljes objektumot lecseréli. A hozzáférést létrehozáskor a feltöltéshez, cserekor a kártya módosításához hasonlóan ellenőrzi. A hívó számára csak részben látható kártya tartalma nem cserélődik le (403 cards.content_whole_access). A forrásokból származó kártyák így nem írhatók felül: ha az external_id egy egyéni forrás dokumentumához tartozik, vagy a megtalált kártyát egy forrás kezeli, a válasz 409 cards.managed_by_source. A tartalom módosítása – mint minden új verzió – visszavonja a kártya ellenőrzését (update indokkal).

Hitelesítés

Küldj egy API-kulcsot az Authorization fejlécben: Authorization: Bearer <kulcs>.

Útvonal-paraméterek

external_idstringkötelező
A kártya external_id azonosítója: 1–512 karakter hosszú, a szervezeten belül egyedi karakterlánc.
length ≥ 1, length ≤ 512

Fejlécparaméterek

X-View-Asstring
Csak admin szerepkörű API-kulcsokhoz. A kérést a <profile>[:viewer|verifier|editor] adatprofil nevében hajtja végre, például employee:viewer. A telepítési kulcs nem használhatja ezt a fejlécet (403).

Cookie-paraméterek

kb_view_asstring
A „View as” mód sütije egy munkamenethez. A POST /auth/view-as beállítja, a DELETE /auth/view-as törli.

Kéréstörzs

application/json

Objektum: CardTextUpsert

titlestring
length ≥ 1, length ≤ 200
bodystringkötelező
A kártya szövege a content_type formátumban.
length ≥ 1, length ≤ 500000
content_typeCardTextContentType
collectionstring
Gyűjtemény név szerint, a kártya létrehozásakor. Alapértelmezés szerint a telepítés alapértelmezett gyűjteménye.
collection_idinteger | null
Gyűjtemény azonosító szerint, a kártya létrehozásakor. Ha a collection is meg van adva, a collection_id az irányadó.
folder_idstring | null
A gyűjtemény mappája az új kártyához, ugyanazokkal az ellenőrzésekkel, mint a fájlfeltöltés folder_id mezője.
length ≤ 64
tagsarray of string | null
items ≤ 30
categorystring | null
length ≤ 60
sensitiveboolean | null
owner_idinteger | null
verify_interval_daysinteger | null
≥ 1, ≤ 3650
metadataMetadataPatch
asyncboolean
A true azonnal visszatér, és a kártyát a sorban indexeli; a false az indexelés után tér vissza.
Alapértelmezett: false

multipart/form-data

Objektum: CardFileUpsertForm

filestring (application/octet-stream)kötelező
titlestring | null
A kártya címe. Ha nincs megadva, az új kártya a fájl nevét kapja, a meglévő kártya pedig megtartja a címét.
length ≤ 200
collectionstring
collection_idinteger | null
folder_idstring | null
length ≤ 64
tagsstring
Vesszővel elválasztott címkék.
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
metadatastring | null
metadata: JSON-objektum az űrlapmező értékeként. A szabályok a MetadataPatch szabályai.
asyncboolean
Alapértelmezett: false

Válaszok

200A kártya már létezett. A tartalma lecserélődött (`queued`, `ready`, `error`), vagy nem változott (`skipped`).

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: UploadResult

statusstringkötelező
Megengedett értékek: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged vagy an identical file is already indexed.
tablesinteger
timingsobject
Mezők
- total_snumber
errorstring

201A kártya létrejött (aszinkron kérésnél `queued`, szinkronnál `ready` vagy `error`).

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: UploadResult

statusstringkötelező
Megengedett értékek: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged vagy an identical file is already indexed.
tablesinteger
timingsobject
Mezők
- total_snumber
errorstring

400A kérés érvénytelen: egy paraméter értéke vagy az objektum állapota nem teszi lehetővé a műveletet (a `detail` egy üzenet).

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

401Nem érkeztek hitelesítő adatok (sem munkamenet-süti, sem API-kulcs), vagy a kulcs nem található.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

402A szervezet elérte valamelyik csomagkorlátját (kártyák, tárhely vagy felhasználók). Az `error.details` a `kind`, a `limit` és a `used` mezőt tartalmazza.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

403A művelet nem engedélyezett: a szerepkör nem elegendő, nincs hozzáférés a gyűjteményhez vagy a kártyához, a kérés „View as” módban fut, vagy a szervezetet felfüggesztették vagy törölték (a `detail` egy objektum, `code: org_suspended | org_deleted` mezővel).

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

404Az objektum nem létezik, vagy nem érhető el számodra. Az API nem erősíti meg, hogy egy korlátozott hozzáférésű objektum létezik.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

409Az objektum állapota nem teszi lehetővé a műveletet, például ismétlődés, folyamatban lévő indexelés vagy már feldolgozott feladat miatt.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

413A kéréstörzs meghaladja a megengedett méretet.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

415A fájlformátum nem támogatott.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

422Érvényesítési hiba: a törzs vagy a paraméterek nem felelnek meg a sémának (a `detail` az érvényesítési hibák listája), vagy egy paraméter értéke kívül esik a megengedett tartományon (a `detail` egy üzenet).

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

429Túl sok kérés (`api.rate_limited`), elfogyott a szervezet percre, napra vagy hónapra szóló kvótája (`api.quota_exceeded`; az `error.details` a `quota`, a `limit` és a `reset_at` mezőt tartalmazza), a szervezet elérte a korlátját, vagy a válaszszolgáltatás foglalt (`answers.engine_busy`). Várj a `Retry-After` fejlécben megadott ideig.

Válaszfejlécek

Retry-After
Ennyi másodpercet várj, mielőtt újrapróbálod a kérést.
RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

503Egy szolgáltatás, amelytől ez a kérés függ, átmenetileg nem érhető el. Próbáld újra később.

Válaszfejlécek

RateLimit-Policy
Az érvényben lévő korlátok az IETF draft-ietf-httpapi-ratelimit-headers tervezetének formátumában: vesszővel elválasztott "<name>";q=<quota>;w=<window in seconds> elemek. A key az API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnél user, hitelesítő adatok nélkül ip); a minute, a day és a month a szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.
RateLimit
Mennyi maradt a RateLimit-Policy egyes korlátaiból: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
A RateLimit-Policy legszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).
X-RateLimit-Remaining
A legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-Reset
A legszigorúbb korlát visszaállásáig hátralévő másodpercek.

application/json

Objektum: Error

Hibakódok

Azok a kódok, amelyeket ez a végpont hiba esetén az error.code mezőben visszaadhat, a minden kérésre érvényes általános kódokon kívül.

Gyakorisági korlátok

A válaszokban ott van a RateLimit és a RateLimit-Policy fejléc, valamint a korábbi X-RateLimit-Limit, X-RateLimit-Remaining és X-RateLimit-Reset fejléc. A 429-es válasz Retry-After fejléce másodpercben adja meg a várakozást: várj, majd próbáld újra.

← cards · API-referencia

curl -X PUT 'https://api.sursa.com/v1/cards-by-external-id/EXTERNAL_ID' \
  -H "Content-Type: application/json" \
  -d '{"title":"Refund policy","body":"# Refund policy\n\nRefunds are processed within 14 days.","collection":"support"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Kipróbálás

API-kulcs

A kulcs ennek a lapnak a memóriájában marad, és a konzol csak ide küldi el: https://api.sursa.com.

A kérések a szervezeted valódi adataival dolgoznak.

X-View-As header

external_id path *

Kéréstörzs (JSON)