Структура REST API

В REST API виртуальной АТС используется ресурсо-ориентированный подход. В качестве ресурсов выступают клиенты, пользователи клиентов, внутренние номера, группы внутренних номеров, голосовое меню, очередь звонков, факс и т.д. Каждый ресурс имеет свой уникальный идентификатор. Для управления ресурсами в API определены стандартные методы, позволяющие добавлять, получать, изменять и удалять ресурсы.

В данном разделе описана общая структура REST API, форматы запросов и ответов. Запросы к API осуществляются через URL https://<hostname>/api/ver1.0/ , где hostname — hostname API-сервера провайдера IP-телефонии. Для авторизации используется протокол OAuth2, после получения токена через OAuth2, он передается в каждом API-запросе в заголовке Authorization (См. Создание и авторизация приложений).

При наличии тела запроса (запросы типа POST и PUT) его содержимое должно быть передано в формате JSON, заголовок Content-Type должен быть установлен в application/json. Исключение составляет, например, загрузка звуковых файлов.

← Работа с системой Правила запросов к API →