Tài liệu API¶
Bạn có thể xác thực API bằng cách sử dụng OAuth2 hoặc khóa API. OAuth2 là một khung ủy quyền tiêu chuẩn cho phép các ứng dụng truy cập an toàn vào các tài liệu cụ thể trong một hệ thống. Mặt khác, khóa API cung cấp một phương pháp đơn giản hơn để lấy tài liệu từ một cơ sở tri thức chung mà không cần phải trải qua quy trình xác thực OAuth2.
Tổng quan về API¶
Rememberizer cung cấp một bộ API toàn diện để làm việc với tài liệu, kho vector, kỷ niệm và nhiều hơn nữa. Các API được tổ chức thành các danh mục sau:
API Xác Thực¶
- Đăng Ký, Đăng Nhập, Xác Minh Email
- Đặt Lại Mật Khẩu
- Điểm Cuối OAuth (Google, Microsoft)
- Quản Lý Token và Đăng Xuất
API Người Dùng¶
- Hồ Sơ Người Dùng và Thông Tin Tài Khoản
- Quy Trình Đăng Ký Người Dùng
API Tài liệu¶
- Liệt kê, Tạo và Cập nhật Tài liệu
- Xử lý Tài liệu
- Các Hoạt động Tài liệu Theo Lô
Tìm kiếm API¶
- Tìm kiếm cơ bản
- Tìm kiếm chủ động
- Các thao tác tìm kiếm theo lô
APIs Memento¶
- Tạo, Liệt kê, Cập nhật và Xóa Memento
- Quản lý Tài liệu Memento
API Lưu trữ Vector¶
- Tạo và Liệt kê Lưu trữ Vector
- Tải lên Tài liệu Văn bản và Tệp
- Tìm kiếm Lưu trữ Vector
- Tải lên và Tìm kiếm theo Lô
APIs tích hợp¶
- Danh sách tích hợp
- Điểm cuối tích hợp OAuth (Google Drive, Gmail, Slack, Dropbox)
APIs Ứng Dụng¶
- Liệt kê và Tạo Ứng Dụng
API Kiến Thức Chung¶
- Liệt kê và Tạo Mục Kiến Thức Chung
API Đội Nhóm¶
- Quản Lý Đội Nhóm
- Thành Viên Đội Nhóm
- Quyền Truy Cập Dựa Trên Vai Trò
Để biết các mẫu tích hợp doanh nghiệp, các yếu tố bảo mật và các thực tiễn kiến trúc tốt nhất, hãy xem hướng dẫn Mẫu Tích Hợp Doanh Nghiệp.
Địa chỉ URL cơ sở¶
Tất cả các điểm cuối API đều tương đối với:
Xác thực¶
Các điểm cuối yêu cầu xác thực bằng cách sử dụng một trong các phương thức sau: - Mã thông báo JWT (được truyền trong tiêu đề Authorization hoặc cookie) - Khóa API (được truyền trong tiêu đề x-api-key)
Để biết thông tin chi tiết về các điểm cuối cụ thể, hãy tham khảo các trang tài liệu API riêng lẻ.