Документация REST API
Базовый URL: https://api.node07.xyz • Формат: application/json; charset=utf-8 • Лимит POST: 8 КБ • Частота: 15 req/s
/api/ping
Проверка доступности интернета и времени работы узла. Минимальный размер ответа позволяет парсить его без выделения больших буферов в RAM.
$ curl -s https://api.node07.xyz/api/ping
{"status":"ok","message":"pong","node":"node07","uptime_sec":3600,"requests":42191}
| Поле | Тип | Описание |
|---|---|---|
status | string | Состояние узла (всегда "ok" при штатной работе) |
message | string | Контрольный ответ "pong" |
uptime_sec | int | Время непрерывной работы сервера в секундах |
/api/time
Получение точного времени по HTTP/HTTPS для синхронизации внутренних часов (RTC) контроллера в сетях, где заблокирован UDP-порт 123 (NTP).
$ curl -s https://api.node07.xyz/api/time
{"unix":1794808000,"iso":"2026-11-16T05:46:40+00:00","utc":"2026-11-16 05:46:40"}
| Поле | Тип | Описание |
|---|---|---|
unix | int | Секунды с 1 января 1970 года (UTC) |
iso | string | Дата и время в стандарте ISO-8601 |
utc | string | Читаемая строка времени в часовом поясе UTC |
/api/headers
Возвращает HTTP-заголовки, с которыми запрос от контроллера дошёл до сервера. Помогает отлаживать User-Agent, токены авторизации и прокси.
$ curl -s https://api.node07.xyz/api/headers
{"headers":{"host":"api.node07.xyz","user-agent":"ESP32HTTPClient"},"protocol":"HTTP/1.1"}
| Поле | Тип | Описание |
|---|---|---|
headers | object | Словарь всех входящих HTTP-заголовков в нижнем регистре |
protocol | string | Версия HTTP-протокола клиента |
/api/uuid
Генерация случайного уникального идентификатора UUID v4. Удобно для присвоения уникального ID прошивкам без аппаратного генератора случайных чисел.
$ curl -s https://api.node07.xyz
{"uuid":"550e8400-e29b-41d4-a716-446655440000"}
| Поле | Тип | Описание |
|---|---|---|
uuid | string | Случайный 128-битный идентификатор в формате UUID v4 |
/api/echo
Эхо-эндпоинт для проверки отправки JSON-телеметрии с прошивки. Принимает тело до 8192 байт и возвращает его обратно с меткой времени.
$ curl -s -X POST https://api.node07.xyz/api/echo -H "Content-Type: application/json" -d '{"temp":23.5}'
{"received":{"temp":23.5},"timestamp":1794808000}
| Поле | Тип | Описание |
|---|---|---|
received | any | Распарсенный JSON-объект из тела запроса (или строка raw) |
timestamp | int | Unix-время приёма пакета сервером |
Коды ответов HTTP
| Код | Статус | Причина |
|---|---|---|
200 | OK | Запрос успешно обработан |
400 | Bad Request | Некорректный заголовок Content-Length |
404 | Not Found | Неизвестный маршрут API |
413 | Payload Too Large | Тело POST-запроса превышает лимит 8 КБ |
429 | Too Many Requests | Превышен лимит частоты запросов (15 req/s) |
Примеры отрицательных ответов
При ошибках уровня приложения API возвращает JSON с ключом error. При срабатывании защиты веб-сервера (429) возвращается стандартный ответ Nginx.
{"error": "not found"}
{"error": "payload too large"}
{"error": "bad length"}
<html><head><title>429 Too Many Requests</title></head>...