REST API Документация клиента

Настоящая документация описывает порядок работы с функциями, доступными на уровне пользователя системы. Под пользователями понимаются все лица, имеющие учетные данные в системе, которые выдаются администратором.

Библиотека системы Ringme спроектирована в соответствии с архитектурой REST. Запросы к API передаются через протокол HTTPS, авторизация производится по протоколу OAuth 2.0 (RFC 6749).

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

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

Целевая аудитория настоящей документации: программисты или системные администраторы, реализующие графический интерфейс (front-end) и различные скрипты автоматизации. Документ может также быть полезен пользователям, желающим сделать больше, чем позволяет имеющийся графический интерфейс системы.