Документ описывает порядок работы с функциями, доступными на уровне пользователя системы Ringme. Под пользователями понимаются все, имеющие учетные данные Ringme (выдаются администратором). Целевая аудитория: программисты/системные администраторы, реализующие графический интерфейс (front-end) и различные скрипты автоматизации. Документ может быть полезен пользователям, желающим сделать большее, чем позволяет имеющийся графический интерфейс.
Библиотека написана, стараясь соответствовать правилам архитектуры REST, передача данным через https, авторизация на основе протокола OAuth 2.0 (rfc6749).
Документация включает в себя:
- Перечисление основных ресурсов системы
- Порядок авторизации для выполнения действий от имени конкретного пользователя
- Описание имеющихся функций и их параметров
- Примеры использования (на языке Python 2.7)
{metadata:example1}Example 1 Text{metadata}
{run-now}
example1 from metadata: %metadata_example1%
example1 metadata as a property: %property_metadata.example1%
{run-now}