開発者向けONLYOFFICE Docs 8.2：APIの更新

Posted at 2024-10-31

バージョン8.2の新機能リリースに伴い、エディタ用API、Office API、プラグインを更新し、ドキュメントビルダー用のJavaフレームワークとPHP統合SDKを追加しました。詳細は下記をご覧ください。

ONLYOFFICE Docs 8.2 for developers: API updates

ダウンタイムなしの展開

ダウンタイムなしの展開は、アプリケーションを中断することなく更新する優れた方法です。そのため、エディタをオフラインにすることなくアップグレードすることができます。

どのように動作するのでしょうか？新しいバージョンのONLYOFFICE Docs (Document Server, DS) インスタンスは、現在実行中のDocument Serverと並行して起動されます。新しい編集セッションは新しいDSで開かれます。ユーザーが編集セッションを終了するまで、以前のDSバージョンは機能します。その後、以前のDSが停止します。

ONLYOFFICE Docs Shardsについて言えば、編集セッションをクラスタ内の特定のDSに直接指示することができます。したがって、異なるバージョンのドキュメントサーバーを並行して動作させることができます。リソースの複製と更新プロセス自体に時間がかかる可能性があることを考慮に入れてください。

ご注意：ゼロダウンタイム展開は、Kubernetesシャードとして提供されるONLYOFFICE Docsで利用可能です。もっと詳しく知りたい方は、sales@onlyoffice.comまでご連絡ください。

PHP 統合 SDK

ONLYOFFICE Docs を PHP で書かれたアプリケーションに簡単に統合できます。 SDK には、初期化構成の作成とバックエンドの一般的なメソッドの処理を行う、PHP 統合用の一般的なコードが含まれています。こちらをチェック

PHP SDK は現在、例えば、ONLYOFFICE と Chamilo の統合に実装されています。

新しいインターフェーススタイル

editorConfig.customization.featuresパラメータは、tabStyleとtabBackgroundという2つの追加フィールドをもたらします。これにより、エディタの外観を好みに合わせて調整することができます。

前者は、Fill（上部のツールバータブがはっきりと表示される）またはLine style（上部のツールバータブが下線で強調表示される）を設定できます。

後者は、上部のツールバータブの背景がヘッダー背景またはツールバー背景と一致するかどうかを定義します。

さらに、editorConfig.customization.logoパラメータにimageLightフィールドを追加しました。これは、新たに追加された灰色テーマのライトヘッダーで使用される画像ファイルへのパスを定義します。

const logo = {
  image: "https://example.com/logo.png",
  imageDark: "https://example.com/dark-logo.png",
  imageLight: "https://example.com/light-logo.png",
  url: "https://example.com",
  visible: true,
}

サードパーティソースからのテキスト挿入

setRequestedDocument メソッドの c パラメータに、insert-text タイプのドキュメント選択が追加されました。これにより、ユーザーはローカル/URL/ストレージファイルからドキュメントを選択し、その内容を現在のドキュメントに挿入することができます。

docEditor.setRequestedDocument({
  c: "insert-text",
  fileType: "docx",
  url: "https://example.com/url-to-example-document.docx",
...

文書のステータス確認

infoコマンドのレスポンスにユーザーパラメータが追加されました。このパラメータは、文書を編集用に開いたユーザーの識別子のリストを定義します。文書が変更された場合、ユーザーは最後に文書を編集したユーザーの識別子を返します。

{
  "error": 0,
  "key": "Khirz6zTPdfd7",
  "users": ["6d5a81d0", "78e1e841"]
}

Docs APIで他に変更された点

保護されたドキュメントで動作するWOPI変換API用の新しいリクエストパラメータ：PasswordおよびPasswordToOpen
コマンドサービスのhttps://documentserver/coauthoring/CommandService.ashxアドレスがhttps://documentserver/coauthoring/commandに置き換えられました
editorConfig.locationフィールドは廃止されました。すべてのエディタタイプでデフォルトの測定単位を定義するには、代わりにeditorConfig.regionフィールドを使用してください
editorConfig.customization.toolbarNoTabsフィールドは廃止されました。代わりにeditorConfig.customization.features.tabStyleおよびeditorConfig.customization.features.tabBackgroundフィールドを使用してください