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