オープンコラボレーションサービス

OCSロゴの色
OCS APIロゴ

オープンコラボレーションサービス(OCS)は、アプリをコンテンツコラボレーションプラットフォームに簡単に接続できるように設計された、オープンでベンダーに依存しないRESTおよびWebDAVベースのAPIです。 [ 1 ]

OCS APIは、ファイルアクセス、共有、バージョン管理、コメント機能といった基本的なファイル処理機能を提供します。また、コミュニケーション(チャット、ビデオ通話)、カレンダー管理、タスク管理などもサポートしています。

OCS APIは、ウェブコミュニティやウェブベースのサービスをデスクトップアプリケーションやモバイルアプリケーションに統合することを可能にします。これにより、ソーシャルネットワークから取得した関連データを、サイトとクライアント(他のウェブサイトやアプリケーション、ユーザーのマシンやモバイルデバイス上でローカルに実行されるウィジェットなど)間で交換できます。このプロトコルは、すべてのアプリケーションがOCS APIを提供する複数のサービスにアクセスできるよう設計されています。

初期のAPI設計は、ソーシャルデスクトップの一環として、特にクロスデスクトップバックエンドプロバイダーとしてopenDesktop.orgによって行われました。[ 2 ] APIはfreedesktop.orgによって標準化され、サードパーティプロバイダーがOCS APIを実装できるようになりました。現在、NextcloudはOCS APIを実装・開発しており、その一部は他の様々なプロジェクトや多くのサードパーティ製アプリやツールでもサポートされています。[ 3 ]

過去にAPIを使用していた非KDE環境には、Maemo Downloadsアプリケーションストア[ 4 ]とApps for MeeGo [ 5 ]が含まれていました。

モジュール

OCS APIドキュメント[ 6 ]にはいくつかのモジュールがリストされています。主要なOCSモジュールは次のとおりです。

  • ユーザーメタデータ
  • 機能
  • OCSシェア
  • OCS シェア
  • OCSステータス
  • OCSの推奨事項
  • OCS ユーザー設定
  • OCS 翻訳 API
  • OCS テキスト処理
  • OCS テキストから画像へ
  • OCS タスク処理
  • OCS 不在通知

OCS API ビューア

OCS APIビューア[ 7 ]は、ブラウザからインタラクティブにAPIを発見し、自分のインスタンスで試すことができる Nextcloudアプリです。

例えば、ファイル共有を更新したい場合は、「file_sharing」→「shareapi」→「update a share」と進み、ファイルIDを追加します。「Send API request」をクリックすると、サーバーからのレスポンスと共有の作成方法を確認できます。さらに、このリクエストを実行するための様々なプログラミング言語のコードスニペットも表示されます。

参考文献