O API

Nasze API opiera się na standardowym protokole HTTP i wymaga uwierzytelnienia tokenem.

Państwa token dostępny jest na stronie Dostęp do API (Ustawienia->Dostęp do API). Prosimy traktować go jak hasło i nie udostępniać osobom nieuprawnionym. W przypadku "wycieku" tokena, można wygenerować nowy, stary przestanie być wtedy aktywny.

Korzystanie z API

Dane zwracane i przyjmowane przez API są w formacie JSON.

Wszystkie żądania do API odbywają się za pośrednictwem bezpiecznego połączenia szyfrowanego TSL/SSL. Każde żądanie wysłane do API musi zostać uwierzytelnione tokenem poprzez nagówek HTTP:

Authorization: Token XXXXXXXXXXXXXXXXXXXXX

gdzie ciąg X jest zastąpiony przez właściwy token.

Większość języków programowania udostępnia gotowe biblioteki pozwalające w prosty sposób korzystać z protokołu HTTP. W celu testowania API można użyć programu curl w konsoli. Program curl jest dostępny w większości dystrybucji linuksa, można też pobrać wersję dla systemu Windows.

Powiadomienia o niedostępności

 

Sprawdzanie ustawienia powiadomień

Aby sprawdzić stan powiadomień dla wybranego testu należy użyć metody HTTP GET na "zasobie" (URL) odpowiadającemu temu testowi. Przykład z wykorzystaniem narzędzia curl:

curl -H "Authorization: Token XXXXXXXXXXXXXXXXXX" -X GET https://panel.monitoringwww.pl/api/v1/tests/ID_TESTU/alerts/

gdzie ID_TESTU należy zamienić na identyfikator numeryczny testu. Można do odczytać z adresu stron z raportami dotyczącymi testu, już niedługo będzie można pobrać listę testów bezpośrednio z API.

W przypadku, gdy wysyłanie powiadomień jest włączone, API zwróci następującą odpowiedź:

{"paused": false}

W przeciwnym przypadku, gdy powiadomienia są wyłączone:

{"paused": true} 

Wyłączanie wysyłania powiadomień

Aby wyłączyć wysyłanie powiadomień dla testu należy użyć metody HTTP PATCH na "zasobie" odpowiadającemu testowi, w ciele żądania HTTP należy podać nową wartość. Przykład z wykorzystaniem narzędzia curl:

curl -H "Authorization: Token XXXXXXXXXXXXXXXXXX" -H "Content-Type: application/json" -X PATCH --data '{"paused": true}' https://panel.monitoringwww.pl/api/v1/tests/ID_TESTU/alerts/ 

Rezultatem takiego żądania będzie nowa wartość ustawienia powiadomień:

{"paused": true}

Włączanie wysyłania powiadomień

Aby włączyć wysyłanie powiadomień dla testu należy wykonać analogiczne do powyższego żądanie, ale z wartością

{"paused": false}

Przykład z wykorzystaniem narzędzia curl:

curl -H "Authorization: Token XXXXXXXXXXXXXXXXXX" -H "Content-Type: application/json" -X PATCH --data '{"paused": false}' https://panel.monitoringwww.pl/api/v1/tests/ID_TESTU/alerts/

Rezultatem takiego żądania będzie nowa wartość ustawienia powiadomień:

{"paused": false}

Mamy nadzieję, że powyższy opis pomoże Państwu zacząć korzystać z naszego API. Prosimy o kontakt jeżeli potrzebują Państwo pomocy z integracją API z własnym systemem lub mają jakiekolwiek pytania.