Przejdź do treści
Sursa Developers

Dokumentacja API

Publiczne API Sursy: 222 operacje w 35 sekcjach. Wersja 1.62.0.

Publiczne API Sursy dla integracji uwierzytelniających się kluczem API. Zmiany w obrębie /v1 są rozszerzające: mogą pojawiać się nowe operacje, parametry opcjonalne, pola odpowiedzi i wartości wyliczeń w odpowiedziach, a istniejące aplikacje klienckie nadal działają. Nieznane wartości wyliczeń w odpowiedziach traktuj jako prawidłowe.

Bazowy adres URL
https://api.sursa.com
Uwierzytelnianie
Wyślij klucz API w nagłówku Authorization: Authorization: Bearer <klucz>.

Sekcje

health1 operacja

Stan i wersja usługi

auth1 operacja

Logowanie, sesje, tryb „View as”, zmiana i resetowanie hasła, przyjmowanie zaproszeń

users5 operacji

Konta użytkowników organizacji

api-keys9 operacji

Klucze API organizacji

apps8 operacji

Aplikacje OAuth organizacji i autoryzacje pracowników

oauth3 operacje

Protokół OAuth 2.0: ekran zgody, wydawanie i unieważnianie tokenów, metadane serwera autoryzacji

audit4 operacje

Dziennik audytu organizacji

org1 operacja

Organizacja, jej logo i eksport danych

categories4 operacje

Kategorie dokumentów

collections6 operacji

Kolekcje wiedzy

cards26 operacji

Karty wiedzy: przesyłanie, treść, tabele, wersje, weryfikacja, komentarze

jobs5 operacji

Kolejka indeksowania: zadania, podgląd parsowania, strumień zmian (SSE)

conversations2 operacje

Rozmowy z asystentem

answers3 operacje

Wyszukiwanie i odpowiedzi asystenta, w tym strumień SSE

access-requests4 operacje

Prośby o dostęp do źródeł ukrytej odpowiedzi

questions10 operacji

Dziennik pytań, podpowiedzi, eksporty odpowiedzi, odpowiedź na żywo

files8 operacji

Pliki eksportu

insights1 operacja

Analizy wiedzy: podsumowanie, duplikaty, luki w wiedzy i kondycja wiedzy

tasks1 operacja

Zadania do wykonania użytkownika i zespołu

sources19 operacji

Źródła danych, np. Google Drive i Confluence

permissions17 operacji

Model dostępu: rejestr uprawnień oraz uprawnienia do organizacji, kolekcji, kart i źródeł, zarówno przypisane bezpośrednio, jak i dziedziczone

roles4 operacje

Role: nazwane zestawy uprawnień, wbudowane i niestandardowe

groups7 operacji

Grupy użytkowników: zwykłe grupy, „All members”, grupy ról i grupy osobiste

folders7 operacji

Foldery kolekcji: drzewo o głębokości do trzech poziomów, kolejność względem elementu równorzędnego, jedna karta w kilku folderach, dziedziczone uprawnienia

catalog6 operacji

Katalog usług zewnętrznych (SaaS i dostawcy) z nazwami, witrynami, kategoriami, ikonami i opisami oraz powiązania nazw używanych w Twojej organizacji z pozycjami katalogu

drafts6 operacji

Szkice i zatwierdzanie publikacji

verification9 operacji

Weryfikacja: status, terminy, weryfikatorzy, historia, kolejka „Verify first”, Trust Score i offboarding

announcements5 operacji

Ogłoszenia obowiązkowe do przeczytania: odbiorcy, potwierdzenie przeczytania, raporty, przypomnienia, eksport

comments4 operacje

Komentarze do kart w wątkach, z zakotwiczeniem i statusem, oraz reakcje

webhooks17 operacji

Webhooki organizacji: adresy odbiorców, subskrypcje zdarzeń, podpisy, dostarczenia i ponowienia

public-api1 operacja

Publiczne API dla integracji: specyfikacja tego API w formacie do odczytu maszynowego

uploads5 operacji

Przesyłanie wieloczęściowe dużych plików: sesja, części, zakończenie ze sprawdzeniem oraz użycie przez kartę, archiwum lub import

analytics4 operacje

Analityka produktu: zdarzenia użycia, liczniki obiektów, pulpity kondycji, użycia i wkładu, raport przed odnowieniem umowy i eksporty

quality3 operacje

Jakość odpowiedzi: pytania bez dobrej odpowiedzi i luki w wiedzy przyjęte do realizacji

finance6 operacji

Dokumenty finansowe: kursy walut i katalog kontrahentów

Obiekty