API Introduction
----------------

The secure and comprehensive API provides a single point of integration with 
multiple business systems that require information and use functionality
exposed by the product, the underlying managed network and related products
that are enabled by the core.

The REST-based API covers all functionality provided by the product and 
includes a comprehensive JSON-based schema with schema rules, metadata and 
data that simplifies integration.

Refer to the |API Guide| for more information on integrating with the |VOSS Automate| API.  

For a reference of the schema and the operations applicable for each resource in the system,
refer to the relevant API Reference.  Resources are classified by the type of model in the 
system (data, device, domain, relation or view), for example ``data/AccessProfile``, 
``device/cucm/Phone``, and so on.  Depending on the installed modules and their feature packages, 
the API of feature package models may be available, for example ``relation/Subscriber``, 
``view/QuickSubscriber``, and so on.

The product is fully integrated with external LDAP directories and SAML 
identity providers, allowing users to utilize existing identity management 
system to provide seamless access to portals developed using the product.

.. note::

   References to HCM-F and Shared Data Repository (SDR)
   are only relevant if installed.
 


.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM
.. |API Guide| replace:: API Guide