Open Collaboration Services

Last updated
OCS API logo OCS logo color.svg
OCS API logo

The Open Collaboration Services (OCS) is an open and vendor-independent REST and WebDAV based API designed to make it easy to connect apps to a content collaboration platform. [1]

Contents

The OCS API provides basic file handling features such as file access, sharing, versioning and commenting. It also supports communication (chat, video calls), calendaring, tasks and more.

The OCS API allows for the integration of web communities and web-based services into desktop and mobile applications. It allows the exchange of relevant data from a social network between the site and clients such as other websites and applications or widgets running locally on the user's machine or mobile device. The protocol is designed so that all applications can access multiple services providing OCS APIs.

The initial API design was done by openDesktop.org as part of the Social Desktop, especially as a cross-desktop backend provider. [2] The API was standardised by freedesktop.org so that third-party providers are able to implement OCS API. Currently, Nextcloud implements and develops the OCS API, with parts also supported in various other projects and by many third party apps and tools. [3]

Non-KDE environments using the API in the past included the Maemo Downloads application store [4] and Apps for MeeGo. [5]

Modules

The OCS API documentation [6] lists several modules. Here are the key OCS modules:


OCS API Viewer

The OCS API Viewer [7] is a Nextcloud app where you can interactively discover APIs and try them out on your own instance from the browser.

For example, if you wanted to update a (file) share, you can go to file_sharing –> shareapi –> update a share and add the file ID. Hit “Send API request” and you can see the response from the server, and how the share was created. On top of that, it shows you code snippets for many different programming languages for executing this request.

Related Research Articles

<span class="mw-page-title-main">Qt (software)</span> Object-oriented framework for software development

Qt is cross-platform application development framework for creating graphical user interfaces as well as cross-platform applications that run on various software and hardware platforms such as Linux, Windows, macOS, Android or embedded systems with little or no change in the underlying codebase while still being a native application with native capabilities and speed.

In computing, a desktop environment (DE) is an implementation of the desktop metaphor made of a bundle of programs running on top of a computer operating system that share a common graphical user interface (GUI), sometimes described as a graphical shell. The desktop environment was seen mostly on personal computers until the rise of mobile computing. Desktop GUIs help the user to easily access and edit files, while they usually do not provide access to all of the features found in the underlying operating system. Instead, the traditional command-line interface (CLI) is still used when full control over the operating system is required.

freedesktop.org (fd.o), formerly X Desktop Group (XDG), is a project to work on interoperability and shared base technology for free-software desktop environments for the X Window System (X11) and Wayland on Linux and other Unix-like operating systems. Although freedesktop.org produces specifications for interoperability, it is not a formal standards body.

digiKam Free image organizer

digiKam is a free and open-source image organizer and tag editor written in C++ using the KDE Frameworks.

The following tables compare general and technical information for a number of office suites:

<span class="mw-page-title-main">Gwenview</span> Image viewer software for KDE

Gwenview is an image viewer for Unix-like systems and is released as part of the KDE Applications bundle. The current maintainer is Aurélien Gâteau. The word "Gwen" means "white" in the Breton language and is commonly used as a first name.

<span class="mw-page-title-main">KDE Software Compilation 4</span> Software

KDE Software Compilation 4 was the only series of the so-called KDE Software Compilation, first released in January 2008 and the last release being 4.14.3 released in November 2014. It was the follow-up to K Desktop Environment 3. Following KDE SC 4, the compilation was broken up into basic framework libraries, desktop environment and applications, which are termed KDE Frameworks 5, KDE Plasma 5 and KDE Applications, respectively.

GVfs is GNOME's userspace virtual filesystem designed to work with the I/O abstraction of GIO, a library available in GLib since version 2.15.1. It installs several modules that are automatically used by applications using the APIs of libgio. There is also FUSE support that allows applications not using GIO to access the GVfs filesystems.

Remote Desktop Services (RDS), known as Terminal Services in Windows Server 2008 and earlier, is one of the components of Microsoft Windows that allow a user to initiate and control an interactive session on a remote computer or virtual machine over a network connection. RDS was first released in 1998 as Terminal Server in Windows NT 4.0 Terminal Server Edition, a stand-alone edition of Windows NT 4.0 Server that allowed users to log in remotely. Starting with Windows 2000, it was integrated under the name of Terminal Services as an optional component in the server editions of the Windows NT family of operating systems, receiving updates and improvements with each version of Windows. Terminal Services were then renamed to Remote Desktop Services with Windows Server 2008 R2 in 2009.

<span class="mw-page-title-main">OpenDesktop.org</span>

Opendesktop.org is a website portal offering personal cloud services such as storage and communication services, as well as public services in form of a store for libre content publishing and a code hosting site for open development.

OnlyOffice, stylized as ONLYOFFICE, is a free software office suite and ecosystem of collaborative applications. It consists of online editors for text documents, spreadsheets, presentations, forms and PDFs, and the room-based collaborative platform.

<span class="mw-page-title-main">Frank Karlitschek</span>

Frank Karlitschek is a German open source software developer living in Stuttgart, Germany.

ownCloud Free software for cloud computing

ownCloud, a Kiteworks Company, is a free and open-source software project for content collaboration and sharing and syncing of files in distributed and federated enterprise scenarios. It allows companies and remote end-users to organize their documents on servers, computers, and mobile devices and work with them collaboratively while keeping a centrally organized and synchronized state.

<span class="mw-page-title-main">KDE Frameworks</span> Collection of libraries and software frameworks for the Qt framework

KDE Frameworks is a collection of libraries and software frameworks readily available to any Qt-based software stacks or applications on multiple operating systems. Featuring frequently needed functionality solutions like hardware integration, file format support, additional graphical control elements, plotting functions, and spell checking, the collection serves as the technological foundation for KDE Plasma and KDE Gear. It is distributed under the GNU Lesser General Public License (LGPL).

<span class="mw-page-title-main">KDE Gear</span> Set of applications and supporting libraries

The KDE Gear is a set of applications and supporting libraries that are developed by the KDE community, primarily used on Linux-based operating systems but mostly multiplatform, and released on a common release schedule.

<span class="mw-page-title-main">Snap (software)</span> Software deployment system for Linux by Canonical

Snap is a software packaging and deployment system developed by Canonical for operating systems that use the Linux kernel and the systemd init system. The packages, called snaps, and the tool for using them, snapd, work across a range of Linux distributions and allow upstream software developers to distribute their applications directly to users. Snaps are self-contained applications running in a sandbox with mediated access to the host system. Snap was originally released for cloud applications but was later ported to also work for Internet of Things devices and desktop applications.

<span class="mw-page-title-main">Nextcloud</span> Free and open-source file hosting software suite

Nextcloud is a suite of client-server software for creating and using file hosting services. Nextcloud provides functionality similar to Dropbox, Office 365 or Google Drive when used with integrated office suites Collabora Online or OnlyOffice. It can be hosted in the cloud or on-premises. It is scalable, from home office software based on the low cost Raspberry Pi, all the way through to full sized data centers that support millions of users. Translations in 60 languages exist for web interface and client applications.

Kopano is an open-source groupware application suite originally based on Zarafa. The initial version of Kopano Core (KC) was forked from the then-current release of Zarafa Collaboration Platform, and superseded ZCP in terms of lineage as ZCP switched to maintenance mode with patches flowing from KC. Kopano WebApp similarly descended from Zarafa WebApp. Since October 2017, Kopano Core is also known more specifically as Kopano Groupware Core, since Kopano B.V. developed more products that were not directly requiring groupware components.

<span class="mw-page-title-main">Collabora Online</span> Online office suite based on LibreOffice

Collabora Online is an open source online office suite built on LibreOffice technology, enabling web-based collaborative real-time editing of word processing documents, spreadsheets, presentations, and vector graphics. Optional apps are available for desktops, laptops, tablets, smartphones, and Chromebooks.

References

  1. "About the OCS API". 2024-07-14.
  2. "Presentation of the Open Collaboration Services and of the Social Desktop on dot.kde.org". May 2009.
  3. "About the OCS API". 2024-07-14.
  4. "Henri Bergius on Akademy, MidGard, Open Collaboration Services and GeoClue". KDE. 2010-07-23.
  5. "Apps for MeeGo service". 2012-02-13.
  6. "OCS API documentation". nextcloud.com. Retrieved 2024-07-14.
  7. "Integrate Nextcloud into your app with the help of the OCS API Viewer". nextcloud.com. 14 August 2023. Retrieved 2024-07-14.