Dokumentacja API Monit24.pl
API umożliwia wykonywanie wszystkich operacji dostępnych z poziomu panelu administracyjnego i nie tylko. Dzięki temu możliwa jest łatwa integracja usług Monit24.pl z zewnętrznymi aplikacjami i narzędziami.
Za pomocą API można między innymi:
- zarządzać usługami Monit24.pl,
- przeglądać historię monitoringu usług,
- modyfikować ustawienia grup, powiadomień i raportów okresowych,
- pobierać dane do wykresów czasu odpowiedzi i dostępności usług,
- udostępniać grupy usług innym użytkownikom,
- generować raporty z działania usług.
API jest zbudowane w oparciu o standardy:
- HTTPS - transport, w tym szyfrowanie przesyłanych danych,
- JSON - format serializacji wymienianych danych,
- OpenAPI - format formalnej specyfikacji API.
Szybki start
Jeśli chcesz szybko poznać podstawy korzystania z API, proponujemy zacząć od lektury wprowadzenia do API.
Pełna dokumentacja
Dokumentacja API jest podzielona następująco:
- Interaktywna dokumentacja poszczególnych operacji API - szczegółowa dokumentacja renderowana na podstawie specyfikacji za pomocą narzędzia Swagger UI. Zawiera opisy wszystkich operacji udostępnianych przez API razem z ich parametrami oraz możliwymi kodami błędów. Umożliwia testowe wywoływanie operacji API z poziomu interfejsu WWW.
- Specyfikacja w formacie OpenAPI - plik JSON zawierający specyfikację API. Można go wykorzystać między innymi w narzędziach Swaggera.
- Przykłady - lista przykładów często wykorzystywanych wywołań operacji API.
- Obiekty i zależności między nimi - opis obiektów występujących w systemie Monit24.pl, zależności między nimi i uprawnień do nich.
- Lista konwencji stosowanych w API - opis ogólnych zasad działania operacji API.
- Standardowe operacje API - zasady, które obowiązują w standardowych operacjach (CRUD).
- Powiadomienia HTTP - opis formatu powiadomień wysyłanych przez HTTP.
- Raporty - opis mechanizmu generowania raportów z działania usług.
- Changelog - historia zmian w API.
- Szybki start - wspomniane wyżej wprowadzenie do API dla nowych użytkowników.
Migracja z API 2.0
Użytkownikom poprzedniej wersji API (2.0) w migracji do wesji 3 pomocne mogą okazać się następujące dokumenty:
- Co nowego w API 3.0? - wysokopoziomowy opis najważniejszych różnic z poprzednią wersją API.
- Lista odpowiedników metod - szczegółowe instrukcje migracji dla wszystkich metod występujących w API 2.
Kontakt
Wszelkie pytania i problemy dotyczące działania API prosimy kierować na adres Biura Obsługi Klienta Monit24.pl.