Chuyển tới nội dung
Sursa Developers

Tài liệu tham chiếu API

Sursa API công khai: 222 endpoint trong 35 phần. Phiên bản 1.62.0.

API công khai của Sursa dành cho các tích hợp xác thực bằng khóa API. Các thay đổi trong /v1 là thay đổi bổ sung: có thể xuất hiện thao tác mới, tham số tùy chọn, trường phản hồi và giá trị enum mới trong phản hồi, còn các client hiện có vẫn tiếp tục hoạt động. Hãy coi các giá trị enum chưa biết trong phản hồi là hợp lệ.

URL gốc
https://api.sursa.com
Xác thực
Gửi khóa API trong header Authorization: Authorization: Bearer <khóa>.

Các phần

health1 endpoint

Trạng thái và phiên bản dịch vụ

auth1 endpoint

Đăng nhập, phiên, chế độ “View as” (Xem với tư cách), đổi và đặt lại mật khẩu, chấp nhận lời mời

users5 endpoint

Tài khoản người dùng của tổ chức

api-keys9 endpoint

Khóa API của tổ chức

apps8 endpoint

Ứng dụng OAuth của tổ chức và ủy quyền của nhân viên

oauth3 endpoint

Giao thức OAuth 2.0: màn hình xin quyền, cấp và thu hồi token, siêu dữ liệu của máy chủ ủy quyền

audit4 endpoint

Nhật ký kiểm toán của tổ chức

org1 endpoint

Tổ chức, logo và xuất dữ liệu của tổ chức

categories4 endpoint

Danh mục tài liệu

collections6 endpoint

Bộ sưu tập tri thức

cards26 endpoint

Thẻ tri thức: tải lên, nội dung, bảng, phiên bản, kiểm chứng, bình luận

jobs5 endpoint

Hàng đợi lập chỉ mục: tác vụ, xem trước kết quả đọc tệp, luồng thay đổi (SSE)

conversations2 endpoint

Cuộc trò chuyện với trợ lý

answers3 endpoint

Tìm kiếm và câu trả lời của trợ lý, bao gồm luồng SSE

access-requests4 endpoint

Yêu cầu truy cập vào nguồn của một câu trả lời bị ẩn

questions10 endpoint

Nhật ký câu hỏi, gợi ý, xuất câu trả lời, câu trả lời động

files8 endpoint

Tệp xuất

insights1 endpoint

Phân tích tri thức: tổng quan, trùng lặp, lỗ hổng tri thức và sức khỏe tri thức

tasks1 endpoint

Công việc của người dùng và của đội

sources19 endpoint

Nguồn dữ liệu, chẳng hạn Google Drive và Confluence

permissions17 endpoint

Mô hình quyền truy cập: danh sách quyền và các quyền trên tổ chức, bộ sưu tập, thẻ và nguồn, cả quyền được gán trực tiếp lẫn quyền kế thừa

roles4 endpoint

Vai trò: các tập quyền có tên, có sẵn và tùy chỉnh

groups7 endpoint

Nhóm người dùng: nhóm thông thường, “All members” (Tất cả thành viên), nhóm theo vai trò và nhóm cá nhân

folders7 endpoint

Thư mục của bộ sưu tập: cây sâu tối đa ba cấp, sắp xếp so với một phần tử cùng cấp, một thẻ trong nhiều thư mục, quyền kế thừa

catalog6 endpoint

Catalog dịch vụ bên ngoài (SaaS và nhà cung cấp) với tên, trang web, danh mục, biểu tượng và mô tả, cùng liên kết giữa các tên trong tổ chức của bạn với các mục của catalog

drafts6 endpoint

Bản nháp và phê duyệt xuất bản

verification9 endpoint

Kiểm chứng: trạng thái, hạn kiểm chứng, người kiểm chứng, lịch sử, hàng đợi “kiểm chứng trước”, điểm tin cậy (Trust Score) và cho rời tổ chức

announcements5 endpoint

Thông báo bắt buộc đọc: đối tượng nhận, xác nhận đã đọc, báo cáo, nhắc nhở, xuất dữ liệu

comments4 endpoint

Bình luận thẻ theo chuỗi, có điểm neo và trạng thái, cùng biểu tượng cảm xúc

webhooks17 endpoint

Webhook của tổ chức: các webhook, đăng ký nhận sự kiện, chữ ký, lần gửi và thử lại

public-api1 endpoint

API công khai cho tích hợp: đặc tả máy đọc được của API này

uploads5 endpoint

Tải lên nhiều phần cho tệp lớn: phiên, các phần, hoàn tất kèm kiểm tra, và sử dụng cho thẻ, tệp lưu trữ nén hoặc lượt nhập

analytics4 endpoint

Phân tích sản phẩm: sự kiện sử dụng, bộ đếm theo đối tượng, bảng điều khiển sức khỏe, mức sử dụng và đóng góp, báo cáo gia hạn và xuất dữ liệu

quality3 endpoint

Chất lượng câu trả lời: các câu hỏi chưa có câu trả lời tốt và các lỗ hổng tri thức đã được đưa vào xử lý

finance6 endpoint

Tài liệu tài chính: tỷ giá và danh bạ đối tác giao dịch

Đối tượng