Přejít na obsah
Sursa Developers

Reference API

Veřejné Sursa API: 222 operací v 35 sekcích. Verze 1.62.0.

Veřejné Sursa API pro integrace, které se ověřují klíčem API. Změny v rámci /v1 jsou rozšiřující: mohou přibýt nové operace, nepovinné parametry, pole odpovědí a hodnoty výčtů v odpovědích, a stávající klienti přitom fungují dál. Neznámé hodnoty výčtů v odpovědích považujte za platné.

Základní URL
https://api.sursa.com
Autentizace
Odešlete klíč API v hlavičce Authorization: Authorization: Bearer <klíč>.

Sekce

health1 operace

Stav služby a verze

auth1 operace

Přihlášení, relace, režim „View as“, změna a obnovení hesla, přijímání pozvánek

users5 operací

Uživatelské účty organizace

api-keys9 operací

Klíče API organizace

apps8 operací

Aplikace OAuth organizace a autorizace zaměstnanců

oauth3 operace

Protokol OAuth 2.0: obrazovka souhlasu, vydávání a odvolávání tokenů, metadata autorizačního serveru

audit4 operace

Auditní protokol organizace

org1 operace

Organizace, její logo a export dat

categories4 operace

Kategorie dokumentů

collections6 operací

Kolekce znalostí

cards26 operací

Znalostní karty: nahrávání, obsah, tabulky, verze, ověření, komentáře

jobs5 operací

Fronta indexování: úlohy, náhled parsování, stream změn (SSE)

conversations2 operace

Konverzace s asistentem

answers3 operace

Vyhledávání a odpovědi asistenta včetně streamu SSE

access-requests4 operace

Žádosti o přístup ke zdrojům skryté odpovědi

questions10 operací

Protokol otázek, návrhy, exporty odpovědí, živá odpověď

files8 operací

Soubory exportu

insights1 operace

Analýzy znalostí: souhrn, duplicity, mezery ve znalostech a zdraví znalostí

tasks1 operace

Úkoly uživatele a týmu

sources19 operací

Zdroje dat, například Google Drive a Confluence

permissions17 operací

Model přístupu: registr oprávnění a oprávnění k organizaci, kolekcím, kartám a zdrojům, přiřazená přímo i zděděná

roles4 operace

Role: pojmenované sady oprávnění, vestavěné i vlastní

groups7 operací

Skupiny uživatelů: běžné skupiny, „All members“, skupiny rolí a osobní skupiny

folders7 operací

Složky kolekcí: strom do hloubky nejvýše tří úrovní, pořadí vůči sousednímu prvku, jedna karta v několika složkách, zděděná oprávnění

catalog6 operací

Katalog externích služeb (SaaS a dodavatelé) s názvy, weby, kategoriemi, ikonami a popisy a propojení názvů vaší organizace s položkami katalogu

drafts6 operací

Koncepty a schválení publikace

verification9 operací

Ověření: stav, termíny, ověřovatelé, historie, fronta „Verify first“, Trust Score a offboarding

announcements5 operací

Oznámení povinná ke čtení: adresáti, potvrzení přečtení, reporty, připomínky, export

comments4 operace

Vlákna komentářů ke kartám s ukotvením a stavem a reakce

webhooks17 operací

Webhooky organizace: adresy příjemců, odběry událostí, podpisy, doručení a opakování

public-api1 operace

Veřejné API pro integrace: strojově čitelná specifikace tohoto API

uploads5 operací

Vícedílné nahrávání velkých souborů: relace, části, dokončení s kontrolami a použití kartou, archivem nebo importem

analytics4 operace

Produktová analytika: události využití, počítadla jednotlivých objektů, přehledy zdraví, využití a příspěvků, podklady k prodloužení smlouvy a exporty

quality3 operace

Kvalita odpovědí: otázky bez dobré odpovědi a mezery ve znalostech převzaté k řešení

finance6 operací

Finanční dokumenty: směnné kurzy a adresář protistran

Objekty