Исправил баг с загрузкой конфигурации AP сети в Settings. Добавил возможность изменять из в админ панели. Применил их к AP сети. Изменил функциональность endpoint'ов и удалил лишние. Обновил README
This commit is contained in:
@@ -20,78 +20,83 @@ Password: admin
|
||||
|
||||

|
||||
|
||||
## API управления (Управляющие Endpoint'ы)
|
||||
## API
|
||||
|
||||
Все эндпоинты управления требуют **HTTP Basic Auth** авторизации. В случае неуспешной авторизации сервер возвращает статус `401 Unauthorized`.
|
||||
Все перечисленные endpoint'ы требуют **HTTP Basic Auth**. При неуспешной авторизации сервер возвращает `401 Unauthorized`. Для запросов с JSON передавайте данные в теле запроса.
|
||||
|
||||
При отправке настроек, некорректный JSON или отсутствие обязательных полей вызовет ответ со статусом `400 Bad Request`.
|
||||
|
||||
---
|
||||
Некорректный JSON, неверный формат IP-адреса или отсутствие обязательных полей приводит к ответу `400 Bad Request`.
|
||||
|
||||
### Обновление настроек точки доступа (AP)
|
||||
* **URL:** `/settings/ap_update`
|
||||
* **Метод:** `POST` (передается в теле запроса `plain`)
|
||||
* **Тело запроса (JSON):**
|
||||
```json
|
||||
{
|
||||
"ssid": "Имя_сети_AP",
|
||||
"pass": "Пароль_сети_AP"
|
||||
}
|
||||
```
|
||||
* **Ответ:** `200 OK` (после успешного сохранения устройство перезагружается).
|
||||
- **URL:** `/settings/ap_update`
|
||||
- **Метод:** `POST`
|
||||
- **Поля JSON:** `ssid` и `pass` должны передаваться вместе; оба поля можно не указывать. Также можно передать `ip`, `gateway` и `mask` независимо друг от друга.
|
||||
|
||||
### Обновление настроек подключения к роутеру (STA)
|
||||
* **URL:** `/settings/sta_update`
|
||||
* **Метод:** `POST`
|
||||
* **Тело запроса (JSON):**
|
||||
```json
|
||||
{
|
||||
"ssid": "Имя_вашего_WIFI",
|
||||
"pass": "Пароль_от_WIFI"
|
||||
}
|
||||
```
|
||||
* **Ответ:** `200 OK` (после успешного сохранения устройство перезагружается).
|
||||
```json
|
||||
{
|
||||
"ssid": "Имя_сети_AP",
|
||||
"pass": "Пароль_сети_AP",
|
||||
"ip": "192.168.4.1",
|
||||
"gateway": "192.168.4.1",
|
||||
"mask": "255.255.255.0"
|
||||
}
|
||||
```
|
||||
|
||||
Ответ: `200 OK`; после сохранения устройство перезагружается.
|
||||
|
||||
### Обновление настроек подключения к внешней сети (STA)
|
||||
- **URL:** `/settings/sta_update`
|
||||
- **Метод:** `POST`
|
||||
- **Обязательные поля JSON:** `is_conn_out` (boolean), `ssid` и `pass` (строки).
|
||||
|
||||
```json
|
||||
{
|
||||
"is_conn_out": true,
|
||||
"ssid": "Имя_вашего_WIFI",
|
||||
"pass": "Пароль_от_WIFI"
|
||||
}
|
||||
```
|
||||
|
||||
Ответ: `200 OK`. Если `is_conn_out` равен `true`, устройство перезагружается. При `true` поле `ssid` не может быть пустым.
|
||||
|
||||
### Изменение пароля администратора
|
||||
* **URL:** `/settings/admin_update`
|
||||
* **Метод:** `POST`
|
||||
* **Тело запроса (JSON):**
|
||||
```json
|
||||
{
|
||||
"new_pass": "Новый_пароль_админа"
|
||||
}
|
||||
```
|
||||
* **Ответ:** `200 OK`.
|
||||
- **URL:** `/settings/admin_update`
|
||||
- **Метод:** `POST`
|
||||
- **Обязательное поле JSON:** `new_pass`.
|
||||
|
||||
### Получение статуса внешнего подключения (Conn Out)
|
||||
* **URL:** `/settings/is_conn_out`
|
||||
* **Метод:** `GET`
|
||||
* **Ответ:** `200 OK` c JSON-контентом `application/json`:
|
||||
```json
|
||||
{
|
||||
"is_conn_out": true
|
||||
}
|
||||
```
|
||||
```json
|
||||
{
|
||||
"new_pass": "Новый_пароль_админа"
|
||||
}
|
||||
```
|
||||
|
||||
### Установка статуса внешнего подключения (Conn Out)
|
||||
* **URL:** `/settings/set_conn_out`
|
||||
* **Метод:** `POST`
|
||||
* **Тело запроса (JSON):**
|
||||
```json
|
||||
{
|
||||
"is_conn_out": true
|
||||
}
|
||||
```
|
||||
* **Ответ:** `200 OK` (после успешного изменения устройство перезагружается).
|
||||
Ответ: `200 OK`.
|
||||
|
||||
### Получение текущих настроек
|
||||
Возвращает настройки сети без паролей.
|
||||
- **URL:** `/settings/current_settings`
|
||||
- **Метод:** `GET`
|
||||
- **Ответ:** `200 OK`, `application/json`.
|
||||
|
||||
```json
|
||||
{
|
||||
"ip": "192.168.4.1",
|
||||
"gateway": "192.168.4.1",
|
||||
"mask": "255.255.255.0",
|
||||
"sta_ssid": "Имя_вашего_WIFI",
|
||||
"ap_ssid": "Имя_сети_AP",
|
||||
"is_conn_out": true
|
||||
}
|
||||
```
|
||||
|
||||
### Получение списка подключенных клиентов
|
||||
Возвращает сетевые параметры устройств, подключенных в данный момент к точке доступа коммутатора (SoftAP).
|
||||
* **URL:** `/user_list`
|
||||
* **Метод:** `GET`
|
||||
* **Ответ:** `200 OK` с JSON-контентом `application/json`:
|
||||
```json
|
||||
{
|
||||
"user_ip": ["192.168.4.2", "192.168.4.3"],
|
||||
"user_mac": ["a1:b2:c3:d4:e5:f6", "7a:8b:9c:0d:1e:2f"]
|
||||
}
|
||||
```
|
||||
Возвращает IP- и MAC-адреса устройств, подключенных к точке доступа (SoftAP).
|
||||
- **URL:** `/user_list`
|
||||
- **Метод:** `GET`
|
||||
- **Ответ:** `200 OK`, `application/json`.
|
||||
|
||||
```json
|
||||
{
|
||||
"user_ip": ["192.168.4.2", "192.168.4.3"],
|
||||
"user_mac": ["a1:b2:c3:d4:e5:f6", "7a:8b:9c:0d:1e:2f"]
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user