Статья находится в стадии создания!

MC04-DSL-3U API

Общие положения

API аппаратуры MC04-DSL-3U используется для получения состояния аппаратуры и управления ее работой через сеть передачи данных. Одним из примеров использования API является управление аппаратурой веб-браузером посредством встроенного в аппаратуру веб-интерфейса.

API построен на клиент-серверной архитектуре и использует встроенный в аппаратуру MC04-DSL-3U HTTP (HTTPS) сервер. Любое взаимодействие с ааппаратурой посредством API представляет собой последовательность "запрос-ответ": клиент передает серверу запрос, на который получает от сервера ответ.

Протокол

Для передачи запросов API и получения ответов может использоваться как HTTP, так и HTTPS протокол. Рекомендуется использовать протокол HTTPS как более защищенный и безопасный, однако следует учитывать, что для работы этого протокола аппаратуре MC04-DSL-3U требуется дополнительная настройка (установка сертификатов), и если такую настройку не произвести, протокол HTTPS окажется недоступен.

Для передачи запроса используется URI вида http[s]://<host>/api.php, например:

https://mc04.domain.org/api.php.

Примечание: в аппаратуре ранних версий в URI для некоторых запросов должен был использоваться путь отличный от /api.php. Такие случаи оговариваются в описаниях конкретных запросов.

Для отправки запроса серверу могут использоваться методы GET и POST. Предпочтительным является использование метода POST.

Структура данных

Все запросы API и ответы на них представляют собой ​JSON-объекты. Данные запросов и ответов в таком объекте имеют следующий вид:

{"key1":value,"key2":value...}

При использовании метода GET JSON-объект передается серверу как значение параметра json, например:

https://mc04.domain.org/api.php?json={"key":123,"key2":"labuda"}

При использовании метода POST