Данная документация описывает порядок работы с функциями, доступными на уровне пользователя системы Ringme. Под пользователями понимаются все, имеющие учетные данные Ringme (выдаются администратором). Целевая аудитория: программисты/системные администраторы, реализующие графический интерфейс (front-end) и различные скрипты автоматизации. Документ может быть полезен пользователям, желающим сделать большее, чем позволяет имеющийся графический интерфейс.
Библиотека реализована в соответствии с архитектурой REST, передача данных осуществляется через протокол HTTPS, авторизация производится по протоколу OAuth 2.0 (RFC 6749).
Документация включает в себя:
- Перечисление основных ресурсов системы
- Порядок авторизации для выполнения действий от имени конкретного пользователя
- Описание имеющихся функций и их параметров
- Примеры использования (на языке Python 2.7)
Разделы в процессе разработки отмечены знаком "#". Для таких разделов можно использовать автоматически созданный справочник по функциям.