Server SDK

Univer Server SDK は組み合わせて使うモジュール群です。 必要なモジュールを自分のバックエンドに組み込み、そのアプリをデプロイします。認証、権限、文書の所有関係、ファイル保存、運用はアプリ側の責任です。

このページではバックエンドの設定、ストレージ、権限を説明します。共同編集の統合ではエディターを共有ドキュメントに接続し、ファイル交換の統合ではアップロード、変換、ダウンロードを扱います。必要な機能のガイドを選んでください。ライセンスが必要な機能はライセンス設定から始めます。ブラウザー内だけでの編集に共同編集サービスは不要です。

統合の順序

1. Quick Start：独立した 2 つのブラウザー環境で双方向編集を確認します。
2. 永続化：SQLite サンプルを再起動し値を確認します。
3. 認証と権限：editor と viewer を確認します。
4. 業務フロントエンド：デモの認証、文書作成、URL を置き換えます。
5. 拡張機能：履歴、コメント、Worktree、Exchange を追加します。ファイル変換だけなら Exchange から開始できます。

必要なサービスを選ぶ

必要な機能だけを選びます。ファイル変換だけなら共同編集は不要です。SDK 環境を準備し、Univer パッケージのバージョンに互換性を持たせてください。

アプリケーションとストレージの接続

選んだサービスの例を実行してから、バックエンドに接続します。共同編集ドキュメントはアプリケーションが作成し、所有者を記録して ID をブラウザーに返します。作成 API はモジュールの境界を参照してください。ユーザー、プロジェクト、フォルダーは引き続きアプリケーションが管理します。

共同編集の例はメモリストレージを使用するため、再起動で内容が失われます。データベースアダプターに従ってデータベースを接続し、保存したドキュメントが再起動後も残ることを確認してください。

ファイル変換でもアップロード、タスク、ダウンロードの保存とクリーンアップが必要です。Exchange の例を参照してください。

ログインと権限の接続

ID と認可に従って既存のログイン資格情報を検証し、ユーザーがドキュメントを読み取り・変更できるか確認します。例の固定ユーザーと全許可のルールを置き換えてください。

ドキュメントの読み取り、共同編集接続、編集内容の送信、有効にした履歴・コメント・ダウンロードを保護します。ブラウザーの読み取り専用設定はサーバーの権限検証の代わりにはなりません。

デプロイとフロントエンドの接続

アプリケーションのドメインにインターフェースを配置します。共同編集ではプロキシが HTTP と WebSocket の両方を転送する必要があり、HTTPS ページは WSS を使います。アップロードを制限し、変換失敗とタイムアウトを処理してください。単一マシンからインポートとエクスポートの分離、複数の共同編集ノードへ進む手順はデプロイガイドを参照してください。

バックエンドの準備ができたら、対象機能の統合を完了します。

• 共同編集の統合：エディターの接続、共有ドキュメントの作成と表示、同期の検証。
• ファイル交換の統合：アップロード、変換、ダウンロードの接続と実際のファイルでの確認。