.. _customer_api:

Customer API
============

Customer API is designed to be backend for customer portals to allow end-user fetch Rates, Account status(balance and limits) and CDRs and other customer-specific data. Access to Customer API controlled at :ref:`API Access <api_access>` Admin WEB Interface section. Customer API based on `JSONAPI speficication <https://jsonapi.org>`_ and perfectly fit for JS SPA clients.

Automatically generated API documentation included to yeti-web distribution and available at path **/doc/api/customer/v1/index.html**

API documentation on demo instance `<https://demo.yeti-switch.org/doc/api/customer/v1/index.html>`_