===========
API and SDK
===========

XiVO provides a rich set of interfaces to interact with the IPBX and Unified Communications components.

Depending on your needs, you will use either our high-level abstraction layer or direct low-level configuration services.

.. image:: images/api-overview.png
   :alt: XiVO API Architecture Overview
   :align: center


High-Level APIs
===============

.. note:: For CTI Application Developers


The **XUC (XiVO Unified Communications)** server is the recommended entry point for most integrations. It acts as a proxy that authenticates and authorizes requests. It gives then access to:

* **CTI** Using **WebSockets** for real-time call control of telephony events.
* **Configuration** of unified communications features through high-level **REST** APIs.
* **Recording** to manage (listen, find, export...) call recordings.

.. toctree::
   :maxdepth: 2

   xuc/index
   recording/index
   config/index


Low-Level & Admin APIs
======================

.. note:: For System Administrators & Provisioning

Direct access to the core components of the XiVO IPBX for fine-grained configuration and legacy support:

* **Configuration** through *confd* to manage unitary devices, users, lines...
* **Authentication** with *xivo-auth* to manage tokens and permissions (acls)
* **Provisioning** via *provd*  for device management and auto-configuration.
* **System** with *sysconfd* to access network and OS-level settings.

.. toctree::
   :maxdepth: 2

   rest_api/rest_api
   security