Перейти к содержанию
Sursa для разработчиков

Справочник API

Публичный API Sursa: операций — 222, разделов — 35. Версия 1.62.0.

Публичный API Sursa для интеграций, которые аутентифицируются ключом API. Изменения в пределах /v1 только дополняют API: могут появиться новые операции, необязательные параметры, поля ответов и новые значения перечислений в ответах, а существующие клиенты продолжают работать. Считайте незнакомые значения перечислений в ответах допустимыми.

Базовый URL
https://api.sursa.com
Аутентификация
Передайте ключ API в заголовке Authorization: Authorization: Bearer <ключ>.

Разделы

health1 операция

Состояние сервиса и версия

auth1 операция

Вход, сессии, режим «Смотреть как», смена и сброс пароля, принятие приглашений

users5 операций

Учётные записи пользователей организации

api-keys9 операций

Ключи API организации

apps8 операций

OAuth-приложения организации и авторизации сотрудников

oauth3 операции

Протокол OAuth 2.0: экран согласия, выдача и отзыв токенов, метаданные сервера авторизации

audit4 операции

Журнал аудита организации

org1 операция

Организация, её логотип и выгрузка данных

categories4 операции

Категории документов

collections6 операций

Коллекции знаний

cards26 операций

Карточки знаний: загрузка, содержимое, таблицы, версии, верификация, комментарии

jobs5 операций

Очередь индексации: задания, предпросмотр разбора, поток изменений (SSE)

conversations2 операции

Беседы с ассистентом

answers3 операции

Поиск и ответы ассистента, в том числе поток SSE

access-requests4 операции

Запросы доступа к источникам скрытого ответа

questions10 операций

Журнал вопросов, подсказки, экспорт ответов, живой ответ

files8 операций

Файлы экспорта

insights1 операция

Инсайты: сводка, дубли, пробелы в знаниях и здоровье знаний

tasks1 операция

Задачи пользователя и команды

sources19 операций

Источники данных, например Google Drive и Confluence

permissions17 операций

Модель доступа: реестр прав и права на организацию, коллекции, карточки и источники — выданные напрямую и унаследованные

roles4 операции

Роли: именованные наборы прав, встроенные и собственные

groups7 операций

Группы пользователей: обычные группы, «Все участники», группы ролей и личные группы

folders7 операций

Папки коллекций: дерево глубиной до трёх уровней, порядок относительно соседней папки, одна карточка в нескольких папках, унаследованные права

catalog6 операций

Каталог внешних сервисов (SaaS и поставщиков) с названиями, сайтами, категориями, значками и описаниями, а также связи между названиями в вашей организации и записями каталога

drafts6 операций

Черновики и согласование публикации

verification9 операций

Верификация: статус, сроки, верификаторы, история, очередь «Сначала проверить», Trust Score и увольнение сотрудников

announcements5 операций

Объявления «Обязательно к прочтению»: аудитория, подтверждение прочтения, отчёты, напоминания, экспорт

comments4 операции

Комментарии к карточкам с ветками, привязкой к фрагменту и статусом, а также реакции

webhooks17 операций

Вебхуки организации: адреса получателей, подписки на события, подписи, доставки и повторы

public-api1 операция

Публичный API для интеграций: машиночитаемая спецификация этого API

uploads5 операций

Загрузка больших файлов по частям: сессия, части, завершение с проверками и использование загрузки карточкой, архивом или импортом

analytics4 операции

Продуктовая аналитика: события использования, счётчики по объектам, дашборды здоровья, использования и вклада, отчёт к продлению и экспорт

quality3 операции

Качество ответов: вопросы без хорошего ответа и пробелы в знаниях, взятые в работу

finance6 операций

Финансовые документы: курсы валют и справочник контрагентов

Объекты