POST/v1/search

Keresés a gyűjteményekben

Hitelesítés

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

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: SearchRequest

querystringkötelező
length ≥ 1
collectionstring
Alapértelmezett: "default"
tagsarray of string | null
exportstring | null
card_idsarray of string | null
items ≤ 50
toolsboolean | null
qualitystring
Az eredmény mögötti keresés sebessége és pontossága közötti egyensúly: a fast gyorsabb, a precise pontosabb. Alapértelmezett érték: precise.
Megengedett értékek: fastprecise

Válaszok

200Sikeres válasz

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: SearchResponse

querystringkötelező
collectionstringkötelező
timingsobjectkötelező
Mezők
- search_msintegerkötelező
hitsarray of SearchHitkötelező

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

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

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

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.

Biztonságos újrapróbálkozás

Minden POST és PATCH kéréssel küldj Idempotency-Key fejlécet (például egy UUID-t). Ha 24 órán belül ugyanazzal a kulccsal megismétled a kérést, a mentett választ kapod vissza, és a kérés nem fut le újra.

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.

← answers · API-referencia

curl -X POST 'https://api.sursa.com/v1/search' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"query":"refund policy"}' \
  -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

Idempotency-Key

Ha a mező üres, minden kéréshez új kulcs készül.

Kéréstörzs (JSON)