Перейти до вмісту
Sursa Developers

Довідник API

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

Публічний API Sursa для інтеграцій, що автентифікуються ключем API. Зміни в межах /v1 лише додають нове: можуть з’являтися нові операції, необов’язкові параметри, поля відповідей і значення переліків у відповідях, а наявні клієнти й далі працюють. Вважайте невідомі значення переліків у відповідях допустимими.

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

Розділи

health1 операція

Стан сервісу та версія

auth1 операція

Вхід, сесії, режим «View as», зміна та скидання пароля, прийняття запрошень

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 операцій

Групи користувачів: звичайні групи, «All members», групи ролей та особисті групи

folders7 операцій

Папки колекцій: дерево глибиною до трьох рівнів, порядок відносно сусіднього елемента, одна картка в кількох папках, успадковані дозволи

catalog6 операцій

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

drafts6 операцій

Чернетки та погодження публікації

verification9 операцій

Верифікація: статус, терміни, верифікатори, історія, черга «Verify first», Trust Score і офбординг

announcements5 операцій

Оголошення «обов’язково до прочитання»: аудиторія, підтвердження прочитання, звіти, нагадування, експорт

comments4 операції

Коментарі до карток у гілках, із прив’язкою та статусом, а також реакції

webhooks17 операцій

Вебхуки організації: адреси отримувачів, підписки на події, підписи, доставки й повтори

public-api1 операція

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

uploads5 операцій

Завантаження великих файлів частинами (multipart): сесія, частини, завершення з перевірками та використання карткою, архівом або імпортом

analytics4 операції

Продуктова аналітика: події використання, лічильники за об’єктами, дашборди здоров’я, використання та внеску, звіт до продовження й експорт

quality3 операції

Якість відповідей: запитання без хорошої відповіді та прогалини в знаннях, взяті в роботу

finance6 операцій

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

Об’єкти