Към съдържанието
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 операции

Качване на големи файлове на части: сесията, частите, завършване с проверки и използване от карта, архив или импорт

analytics4 операции

Продуктова аналитика: събития за използване, броячи по обекти, таблата на здравето, използването и приноса, отчетът за подновяване и експорти

quality3 операции

Качество на отговорите: въпроси без добър отговор и пропуските в знанията, поети за работа

finance6 операции

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

Обекти