Preskočiť na obsah
Sursa Developers

Referencia API

Verejné Sursa API: 222 operácií v 35 sekciách. Verzia 1.62.0.

Verejné Sursa API pre integrácie, ktoré sa overujú kľúčom API. Zmeny v rámci /v1 sú rozširujúce: môžu pribudnúť nové operácie, nepovinné parametre, polia odpovedí a hodnoty výčtov v odpovediach a existujúci klienti pritom fungujú ďalej. Neznáme hodnoty výčtov v odpovediach považujte za platné.

Základná URL
https://api.sursa.com
Autentifikácia
Odošlite kľúč API v hlavičke Authorization: Authorization: Bearer <kľúč>.

Sekcie

health1 operácia

Stav a verzia služby

auth1 operácia

Prihlásenie, relácie, režim „View as“, zmena a obnovenie hesla, prijímanie pozvánok

users5 operácií

Používateľské účty organizácie

api-keys9 operácií

Kľúče API organizácie

apps8 operácií

Aplikácie OAuth organizácie a autorizácie zamestnancov

oauth3 operácie

Protokol OAuth 2.0: obrazovka súhlasu, vydávanie a odvolávanie tokenov, metadáta autorizačného servera

audit4 operácie

Auditný log organizácie

org1 operácia

Organizácia, jej logo a export údajov

categories4 operácie

Kategórie dokumentov

collections6 operácií

Kolekcie znalostí

cards26 operácií

Karty znalostí: nahrávanie, obsah, tabuľky, verzie, overenie, komentáre

jobs5 operácií

Front indexovania: úlohy, náhľad parsovania, stream zmien (SSE)

conversations2 operácie

Konverzácie s asistentom

answers3 operácie

Vyhľadávanie a odpovede asistenta vrátane streamu SSE

access-requests4 operácie

Žiadosti o prístup k zdrojom skrytej odpovede

questions10 operácií

Log otázok, odporúčania, exporty odpovedí, živá odpoveď

files8 operácií

Súbory exportu

insights1 operácia

Analytika znalostí: súhrn, duplicity, medzery v znalostiach a zdravie znalostí

tasks1 operácia

Pracovné úlohy používateľa a tímu

sources19 operácií

Zdroje údajov, napríklad Google Drive a Confluence

permissions17 operácií

Model prístupu: register oprávnení a oprávnenia na organizáciu, kolekcie, karty a zdroje, priradené priamo aj zdedené

roles4 operácie

Roly: pomenované sady oprávnení, vstavané aj vlastné

groups7 operácií

Skupiny používateľov: bežné skupiny, „All members“, skupiny rolí a osobné skupiny

folders7 operácií

Priečinky kolekcií: strom s hĺbkou najviac tri úrovne, poradie voči susednému prvku, jedna karta vo viacerých priečinkoch, zdedené oprávnenia

catalog6 operácií

Katalóg externých služieb (SaaS a dodávatelia) s názvami, webovými stránkami, kategóriami, ikonami a popismi a prepojenia medzi názvami vo vašej organizácii a položkami katalógu

drafts6 operácií

Návrhy a schválenie publikovania

verification9 operácií

Overenie: stav, termíny, overovatelia, história, front „Verify first“, Trust Score a offboarding

announcements5 operácií

Oznámenia s povinným čítaním: adresáti, potvrdenie prečítania, reporty, pripomienky, export

comments4 operácie

Komentáre ku kartám vo vláknach, s ukotvením a stavom, a reakcie

webhooks17 operácií

Webhooky organizácie: nastavenie webhookov, odbery udalostí, podpisy, doručenia a opakovania

public-api1 operácia

Verejné API pre integrácie: strojovo čitateľná špecifikácia tohto API

uploads5 operácií

Viacdielne nahrávanie veľkých súborov: relácia, časti, dokončenie s kontrolami a použitie kartou, archívom alebo importom

analytics4 operácie

Produktová analytika: udalosti používania, počítadlá jednotlivých objektov, prehľady zdravia, používania a príspevkov, podklady k obnoveniu zmluvy a exporty

quality3 operácie

Kvalita odpovedí: otázky bez dobrej odpovede a medzery v znalostiach prevzaté na riešenie

finance6 operácií

Finančné doklady: výmenné kurzy a adresár protistrán

Objekty