Перейти до змісту

Групи та розділи API

Методи API згруповано за напрямами (у Swagger це теги). Нижче — оглядова мапа розділів, щоб швидко зорієнтуватися, де шукати потрібний метод.

Повний перелік — у Swagger

Це оглядовий опис. Точні шляхи, параметри й схеми відповідей завжди дивіться в інтерактивному Swagger вашого сервера: https://<ваш-сервер>/swagger/ (демо: demo.wildcore.tools/swagger). Приклади curl за групами — на сторінці Приклади запитів.

Обладнання та довідники

Група Призначення
device Пристрої: список і картка (GET/POST/PUT/DELETE /device), визначення моделі за IP (/device-detect), порівняння моделі з БД, список для селекторів (/device/options).
device-model Довідник моделей обладнання: CRUD, іконка моделі.
device-group Групи пристроїв: CRUD.
device-access Профілі доступу до обладнання (параметри підключення): CRUD, типові значення (/device-access-defaults).
device-interface Інтерфейси пристроїв: список і картка, історія, типи (/device-interface/types), статистика за типами, перелік ONU з фільтрами (/device-interface/ont-list), пошук за параметрами (/device-interface/search).
interface-marks Позначки інтерфейсів: «обрані» та теги, переліки з пагінацією.

Робота з обладнанням «наживо»

Методи опитування/керування реальним обладнанням у реальному часі.

Група Призначення
switcher-core Універсальний виклик модулів роботи з обладнанням: перелік доступних модулів для пристрою та виконання модуля (GET/POST).
switches Комутатори: інформація по інтерфейсах і ресурсах, VLAN, діагностика кабелю та SFP, скидання лічильників, перезавантаження, збереження конфігурації, зміна налаштувань порту.
routers Маршрутизатори (L3): ARP, прямі маршрути, FDB, інтерфейси, VLAN, ресурси.
router-os Mikrotik RouterOS: address-list, ARP, BGP-сесії, DHCP-сервери/оренди, simple queues, інтерфейси та VLAN, ресурси.
olts OLT: змінні/дані для роботи з ONU та портами.
olts_control Керування OLT: зміна опису порту та інші керуючі дії.
macros / macros-control Виконання макросів на обладнанні (/component/macros/execute), перелік (/component/macros/list), змінні; адміністрування макросів (CRUD, прев'ю).
onts-registration / onts-registration-control Реєстрація ONU: виконання макросу реєстрації, пошук ONU, перелік незареєстрованих (/component/onts_registration/unregistered); адміністрування шаблонів реєстрації (CRUD, прев'ю).

З'єднання й топологія

Група Призначення
links З'єднання між пристроями/інтерфейсами: CRUD, дерево й список з навантаженням, граф топології, опції конфігурації, віджет перевантажених з'єднань.

Моніторинг та аналітика

Група Призначення
analytics Аналітичні таблиці, графіки й віджети: статуси пристроїв та ONU, рівні сигналу, зростання помилок, дублі MAC/ONU, ONU з поганим сигналом тощо.
prometheus-wrapper Часові ряди для графіків: трафік, помилки, CPU/пам'ять/диск, температура, оптичні рівні (RX), напруга.
pinger Доступність пристроїв: статуси, історія падінь, дані для графіків.
events Події/алерти: вибірка за фільтрами, статистика за іменами та критичністю, правила Alertmanager (перегляд/оновлення/валідація), масове закриття подій.
fdb-history Історія FDB (MAC-таблиць) за фільтром, пристроєм або інтерфейсом.

Портал, пошук, вкладення

Група Призначення
portal Глобальний пошук по системі (/portal/search) та пошук найближчих об'єктів за координатами (/portal/nearest-elements).
attachments Вкладення до об'єктів (пристрої/ONU/інтерфейси): завантаження, перелік, метадані, мініатюра, видалення.
qr-generator Генерація QR-коду об'єкта (base64).

Користувачі та доступ

Група Призначення
auth Автентифікація: вхід (POST /auth), вихід (DELETE /logout), крос-автентифікація під іншим користувачем (POST /system/cross-auth). Доступ із довірених мереж виконується від користувача sys (див. Авторизація).
user Користувачі: список і картка, створення/редагування/видалення, генерація ключа (generate-auth-key), закриття сесій, керування 2FA (вмикання/вимикання, дані QR).
user-role Ролі користувачів: CRUD та перелік доступних дозволів (/user-role-permissions).

Система, логи, обслуговування

Група Призначення
system Системна конфігурація (GET/PUT /system/configuration), інформація про сервер (/system/info), параметри для фронтенду (/system/settings), статистика використання, webhook Alertmanager, метрики Prometheus (/metrics), перевірка нової версії, переклади.
system-components Перелік компонентів системи та керування їх станом/конфігурацією.
system-schedule Планувальник: перелік завдань, ключі, звіти про виконання, оновлення розкладу.
system-logs Журнал дій: запис, фільтрація, перелік підтримуваних типів дій.
system-pollers Логи опитувачів обладнання: фільтрація, перелік опитувачів.
system-switcher-core Логи дій із обладнанням: доступні модулі, фільтрація.
oxidized Бекапи конфігурацій: перелік пристроїв, конфіг/статус/посилання пристрою, перевірка підтримки моделі.