Bắt đầu
Tài liệu API O3O Office Online
Dựng O3O Office Online bằng Docker trên máy chủ của bạn, nhúng trình soạn thảo vào ứng dụng web, đấu vào Nextcloud và gọi API REST DocBuilder để chuyển đổi hoặc sinh tài liệu.
Trong trang này
O3O Office Online là bộ soạn thảo văn bản, bảng tính và trình chiếu chạy trong trình duyệt, cài trên máy chủ của chính bạn. Tài liệu này dành cho lập trình viên và quản trị hệ thống: dựng bản Docker, nhúng trình soạn thảo, nối với hệ lưu trữ và gọi API xử lý tài liệu.
Ba thành phần bạn sẽ dùng#
| Thành phần | Việc chính | Đường dẫn qua proxy |
|---|---|---|
Trình soạn thảo cộng tác (o3o-online) | Mở và sửa .docx, .xlsx, .pptx, .odt... trong trình duyệt, nhiều người cùng sửa một tệp. | /browser, /cool, /hosting |
Cổng kiểm soát (o3o-gate) | Đếm phiên soạn thảo và áp trần kết nối của gói, đọc token bản quyền, cung cấp lớp nhúng O3O.Editor và WOPI host nội bộ. | /o3o/ |
DocBuilder (o3o-docbuilder) | API REST không cần trình duyệt: chuyển đổi định dạng, dựng tài liệu từ kịch bản o3oscript, điền mẫu, trích văn bản, siêu dữ liệu và ảnh thu nhỏ. | /v1/ |
Các nhóm tài liệu#
Bắt đầu nhanhDựng bản Docker, mở trình soạn thảo và chuyển một tệp sang PDF.Nhúng trình soạn thảoO3O.Editor: cấu hình, sự kiện, phương thức, JWT và callback lưu.Tích hợp lưu trữNextcloud và WOPI host tự viết.O3O DocBuilder và chuyển đổiChuyển đổi, kịch bản o3oscript, điền mẫu, trích xuất, job bất đồng bộ.Nền tảngGói, đếm kết nối, token bản quyền, xác thực, mã lỗi.Tự dựng và vận hànhBiến môi trường, proxy, TLS, nâng cấp và xử lý sự cố.Tham chiếuTra cứu nhanh endpoint, lược đồ và thuật ngữ.
Bắt đầu từ đâu#
| Bạn là | Nên đọc trước |
|---|---|
| Quản trị hệ thống muốn chạy thử trên máy mình | Bắt đầu nhanh, rồi Kiến trúc và thành phần |
| Đơn vị đang dùng Nextcloud | Chọn cách tích hợp, mục Nextcloud |
| Lập trình viên web muốn mở tài liệu ngay trong ứng dụng | Chọn cách tích hợp, mục lớp nhúng O3O.Editor |
| Hệ thống chỉ cần chuyển đổi hoặc sinh tài liệu tự động | Chọn cách tích hợp, mục chỉ dùng DocBuilder |
| Người mua hoặc phụ trách ngân sách | Các gói và khác biệt tính năng |
Bản v1 có gì#
- Bản Docker DEV dựng bằng một lệnh
docker compose: proxy, máy chủ soạn thảo, o3o-gate, DocBuilder; hồ sơ tuỳ chọnnextcloud. - Đếm phiên soạn thảo đồng thời và áp trần theo gói; phiên đang mở không bao giờ bị ngắt, thao tác lưu không bao giờ bị chặn.
- Lớp nhúng
O3O.Editorvới 7 sự kiện và 5 phương thức, ký cấu hình bằng JWT HS256, callback lưu ký HMAC SHA-256. - DocBuilder với 11 endpoint: chuyển đổi, o3oscript cho văn bản, bảng tính và trình chiếu, điền mẫu
{{truong}}và lặp hàng bảng, trích văn bản, siêu dữ liệu, ảnh thu nhỏ. - Token bản quyền Ed25519 xác minh ngoại tuyến cho bản doanh nghiệp.
Sắp có
Image O3O Office Online dựng từ nguồn (bản phát hành), nhãn trắng cho bản doanh nghiệp, kích hoạt và gia hạn bản quyền trực tuyến, SDK cho các ngôn ngữ, lịch sử phiên bản trong lớp nhúng, biểu đồ trong o3oscript, chỉ số Prometheus.
Quy ước trong tài liệu#
- Máy chủ mẫu trong mọi ví dụ là
http://localhost:8080, tức proxy của bản Docker trên chính máy bạn. - Khoá DocBuilder mẫu nằm trong biến môi trường
O3O_DEMO_KEY. Thay bằng khoá thật trongO3O_DOCBUILDER_API_KEYScủa máy chủ. - Nhãn Beta: đã chạy được nhưng có thể đổi. Nhãn Sắp có: chưa có trong v1, không dùng để lập kế hoạch triển khai.
- Nhãn gói Cộng đồng và Doanh nghiệp trên mỗi endpoint cho biết gói nào gọi được.
- Số đo hiệu năng (thời gian xử lý, số yêu cầu mỗi giây, bộ nhớ) chưa đo; tài liệu không đưa con số cam kết nào cho tới khi có phép đo thật.