Ссылка на актуальное описание API: https://rdba.rosdomofon.com/swagger-ui.html?urls.primaryName=abonents
Работа с API предполагает работу не из браузера, а через серверный программный код.
Для тестирования можно воспользоваться специализированной программой.
Например, https://www.getpostman.com/ или https://install.advancedrestclient.com/#/install.
|
Модель данных |
|
| С упрощенной моделью данных можно ознакомиться по ссылке | |
|
Начало работы |
|
| Авторизация | Работу с API необходимо начинать с авторизации и получения токена |
|
Настройка услуг |
|
| Настройка услуги “Умный домофон“ | Услуга “Умный домофон“ отвечает за возможность открывать дверь и принимать звонки с домофона в мобильном приложении |
| Настройка услуги “Железный домофон“ | Услуга “Железный домофон“ отвечает за возможность блокировать звонки на физическую трубку абоненту |
| Настройка услуги “Персональное видеонаблюдение“ | Услуга “Персональное видеонаблюдение“ отвечает обеспечивает возможность подключения личных камер абонентов |
|
Жизненный цикл абонента в системе |
|
| Заведение абонента и аккаунта | Если известен номер телефона, то прежде всего необходимо завести абонента и аккаунт |
| Заведение квартиры | Далее, необходимо добавить квартиру, к которой будут подключаться услуги |
| Получение списка услуг подъезда | Для подключения абоненту, необходимо получить список доступных услуг по адресу |
| Подключение услуги | После этого, можно подключить выбранные услуги к аккаунту и они станут доступны абоненту |
| Получение списка подключений аккаунта | Просмотр списка подключений аккаунта |
| Получение списка подключений услуги | Просмотр списка подключений услуги |
| Блокировка/разблокировка аккаунта абонента | Блокировка ограничивает доступ ко всем объектам, подключенным к этому аккаунту |
| Блокировка/разблокировка подключений | Кроме блокировки всего аккаунта возможна блокировка подключений отдельных услуг |
| Удаление аккаунта абонента | Заканчивается жизненный цикл удалением аккаунта |
| Изменение номера телефона абонента | Изменение номера телефона создает нового абонента и переносит в него данные с существующего |
|
Управление доступами (делегированием) абонента |
|
| Предоставление доступа | В системе есть возможность предоставить (делегировать) абоненту доступ ко всем услугам другого абонента |
| Получение списка доступов | Для управления доступами есть возможность получения их списка с фильтрацией по абонентам |
| Удаление доступа | Этим методом можно воспользоваться при необходимости отозвать у абонента предоставленный ему доступ |
|
Нотификация абонентов |
|
| Отправка push-уведомлений | Бесплатный и привычный для абонентов способ нотификации - это push-уведомления. Могут быть использованы для оповещений в Чрезвычайных Ситуациях, для информирования от Управляющих Компаний, для поздравлений и т.п. |
|
Чат техподдержки |
|
| Отправка сообщений абонентам | Для отправки сообщения в чат техподдержки необходимо воспользоваться API для отправки push-уведомлений и передать в поле "channel" значение support |
| Получение сообщений абонента | Получение всей переписки с абонентом. Для фильтрации чата техподдержки необходимо передать параметр channel=support |
|
Работа с заявками |
|
| Получение заявки по UID | По уникальному идентификатору можно безопасно получить информацию о заявке, по которой требуется открытие WebView. Подробнее читать тут: Заявки на подключение |
|
Работа с устройствами |
|
| Открытие двери (активация реле) | Активация конкретного реле на конкретном адаптере. Используется для решения задач автоматического открытия. Например, открытие двери при распознавании лица или открытие шлагбаума при распознавании номера автомобиля. |
|
Устаревшие методы |
|
| Добавление и автоматическое подключение услуги "Умный домофон" | Создание услуги "Умный домофон" со стандартным набором параметров и автоматическое подключение ее к аккаунту |
| Добавление и автоматическое подключение услуги "Железный домофон" | Создание услуги "Железный домофон" со стандартным набором параметров и автоматическое подключение ее к аккаунту |