API

This section is dedicated to developers who want to interact with Carbonio using the available APIs.

Carbonio Account, Admin, and Mail API

This set of API is used to interact via SOAP with the main functions of Carbonio

../../../apidoc/api-reference/index.html

Carbonio Authentication

Carbonio Login page

Interact with Carbonio login process and customise the appearance of the login page

../../../apidoc/carbonio-auth/login-page-api.html

SAML configuration

Modify the SAML configuration

../../../apidoc/carbonio-auth/saml-auth-config-api.html

Carbonio Files

Carbonio Files blob

Manage the upload and download of BLOB files and links to them

../../../apidoc/files_blob/index.html

Carbonio Files metadata

Access metadata of Carbonio Files's items

../../../apidoc/files_meta/index.html

An how-to for the Carbonio Files API is available in section Working With the Carbonio Files API

Work Stream Collaboration (Chats)

Chats

Interact with the Chats API

../../../apidoc/carbonio-ws-collaboration/chats-api.html

Meeting

Create and modify meetings and related features

../../../apidoc/carbonio-ws-collaboration/meeting-api.html

Storages

Manage the upload, download, and deletion operations of items in Carbonio Files

../../../apidoc/carbonio-storages/storages-api.html

Backup

Undelete blobs from Carbonio Backup

../../../apidoc/carbonio-backup/backup-api.html

Third-party API

Most of the software integrated in Carbonio exposes its own API to allow for programmatic access to their functionalities. This is the case of clamd, the protocol used by ClamAV. However, clamd defines also potentially dangerous commands like shutdown, that should never be exposed. The solution is therefore to use a different approach, for example using a docker image that acts as a proxy towards clamd’s interface, like for example https://hub.docker.com/r/benzino77/clamav-rest-api (see also the related documentation). This approach has however not yet been thoroughly tested.