Проекты/UptimeKumaAPI: различия между версиями
Nikolay (обсуждение | вклад) (Новая страница: «==Информация о проекте== UptimeKumaAPI - библиотека с открытым исходным кодом для разработчиков...») |
Nikolay (обсуждение | вклад) |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 6: | Строка 6: | ||
==Скачивание== | ==Скачивание== | ||
Скачать библиотеку можно с [https://unkov.su/projects/uptime-kuma-api-dotnet/ официального сайта Unkov]. | Скачать библиотеку можно с [https://unkov.su/projects/uptime-kuma-api-dotnet/ официального сайта Unkov]. | ||
| + | |||
| + | ==Документация== | ||
| + | ===Начало использования библиотеки=== | ||
| + | 1) Если библиотека скачана в виде .dll файла: | ||
| + | |||
| + | - Добавить .dll файл в "Ссылки" к проекту в обозревателе решений Visual Studio. | ||
| + | |||
| + | Если библиотека скачана с NuGet, встроенного в Visual Studio, вышеуказанного делать <strong>не нужно</strong> | ||
| + | |||
| + | 2) Необходимо инициализировать библиотеку с помощью ``using``. Например, <code>using UptimeKumaAPI;</code> | ||
| + | |||
| + | 3) Теперь нужно создать объект главного класса библиотеки. Например, <code>var hub = new KumaAPIHub("https://uptime.unkov.su/");</code> | ||
| + | ===Функции=== | ||
| + | <code>string GetStatusPageConfig(string statusPage = "default")</code> - ``Получить конфигурацию страницы статуса`` | ||
| + | |||
| + | <code>string GetStatusPageIncident(string statusPage = "default")</code> - ``Получить инцидент со страницы статуса`` | ||
| + | |||
| + | <code>string GetStatusPagePublicGroupList(string statusPage = "default")</code> - ``Получить публичный групповой лист страницы статуса`` | ||
| + | |||
| + | <code>string GetMonitorsHearbeatList(string statusPage = "default")</code> - ``Получить список пинга мониторов со страницы статуса`` | ||
| + | |||
| + | <code>string GetMonitorsUptimeList(string statusPage = "default")</code> - ``Получить аптайм мониторов со страницы статуса`` | ||
| + | |||
| + | <code>bool Push(string code, string status = "up", string msg = "OK", string ping = "")</code> - ``Сделать пуш в монитор страницы статуса`` | ||
| + | |||
| + | <code>string GetEntryPage()</code> - ``Получить входную страницу`` | ||
| + | |||
| + | <code>string GetStatusBadge(int monitor)</code> - ``Получить значок статуса монитора`` | ||
| + | |||
| + | <code>string GetUptimeBadge(int monitor, int hours)</code> - ``Получить значок аптайма монитора`` | ||
| + | |||
| + | <code>string GetPingBadge(int monitor, int hours)</code> - ``Получить значок пинга монитора`` | ||
Текущая версия на 11:59, 14 мая 2023
Информация о проекте
UptimeKumaAPI - библиотека с открытым исходным кодом для разработчиков на платформе .NET(языки программирования C#, VB.NET, F#), позволяющая работать с API скрипта для мониторинга работы сервисов и прочих систем — Uptime Kuma. В данный момент присутствуют функции, доступные обычному пользователю: получение данных, конфигурации и подобного. API для работы с административными функциями будет добавлено в следующей версии.
Актуальная версия: 1.0
Скачивание
Скачать библиотеку можно с официального сайта Unkov.
Документация
Начало использования библиотеки
1) Если библиотека скачана в виде .dll файла:
- Добавить .dll файл в "Ссылки" к проекту в обозревателе решений Visual Studio.
Если библиотека скачана с NuGet, встроенного в Visual Studio, вышеуказанного делать не нужно
2) Необходимо инициализировать библиотеку с помощью ``using``. Например, using UptimeKumaAPI;
3) Теперь нужно создать объект главного класса библиотеки. Например, var hub = new KumaAPIHub("https://uptime.unkov.su/");
Функции
string GetStatusPageConfig(string statusPage = "default") - ``Получить конфигурацию страницы статуса``
string GetStatusPageIncident(string statusPage = "default") - ``Получить инцидент со страницы статуса``
string GetStatusPagePublicGroupList(string statusPage = "default") - ``Получить публичный групповой лист страницы статуса``
string GetMonitorsHearbeatList(string statusPage = "default") - ``Получить список пинга мониторов со страницы статуса``
string GetMonitorsUptimeList(string statusPage = "default") - ``Получить аптайм мониторов со страницы статуса``
bool Push(string code, string status = "up", string msg = "OK", string ping = "") - ``Сделать пуш в монитор страницы статуса``
string GetEntryPage() - ``Получить входную страницу``
string GetStatusBadge(int monitor) - ``Получить значок статуса монитора``
string GetUptimeBadge(int monitor, int hours) - ``Получить значок аптайма монитора``
string GetPingBadge(int monitor, int hours) - ``Получить значок пинга монитора``
