Podstawowe informacje
Komunikacja z API odbywa się po protokole https poprzez wysłanie zapytania typu POST, lub PATCH z wymaganymi przez daną metodę parametrami. Każdy użytkownik posiada login i klucz API.
Autoryzacja - basicAuth: przy każdym zapytaniju musisz wysłać nagłówek: zawierający login i klucz użytkownika.
Odpowiedź API zakodowana jest w formacie JSON. Odpowiedź zawsze zawiera informacje o statusie odpowiedzi ResponseCode i treści błędu lub OK w ResponseText. W data zawarte są wszelkie dane zwracane przez wywołaną metodę.
Wszelkie daty zapisane są w polskiej strefie czasowej Europe/Warsaw, tj. UTC+01:00 w formacie yyyy-mm-dd hh:mm:ss. W razie potrzeby strefę czasową można zmienić na stronie Ustawienia -> Moje Konto /Strefa czasowa konta
API URL
ResponseCode | ResponseText | Objaśnienie | Stan odpowiedzi |
---|---|---|---|
-1 | Unknown error | Nieznany błąd | 400 |
0 | OK | Udane uwierzytelnienie. | 200 |
1 | Incorrect authentication | Konieczna jest autoryzacja Basic auth. | 401 |
2 | Invalid credentials | Uwierzytelnienie nieudane. Podany hash jest nieprawidłowy. | 401 |
3 | Invalid input data | W tym zapytaniu wystąpiły błędy. Zazwyczaj opis błędu można znaleźć w odpowiedzi na to zapytanie. | 400 |
429 | Too Many Request | Za dużo żądań w określonym oknie czasowym! | 429 |
Operacja "get-company-info"
Pobiera informacje o koncie.
Metoda | POST |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.get-company-info | Odpowiedni typ operacji | string | Tak |
Parametr | Opis | Format |
---|---|---|
planName | Nazwa aktualnego planu | string |
planExpireAt | Data wygaśnięcia aktualnego planu | string |
name | Nazwa firmy | string |
description | Pełny opis | string |
nip | NIP | int |
regon | REGON | int |
country | Kraj | string |
city | Miasto | string |
address | Ulica | string |
postCode | Kod pocztowy | string |
balance | Saldo | double |
consumption | Spożycie dziennie | double |
domains.count | Liczba domen | int |
domains.working | Liczba monitorów dla domen, które działają poprawnie | int |
domains.stopped | Liczba monitorów, które aktualnie są zatrzymane | int |
domains.warnings | Liczba problemów wykrytych w tej chwili | int |
servers.count | Liczba serwerów | int |
servers.working | Liczba monitorów dla serwerów, które działają poprawnie | int |
servers.stopped | Liczba monitorów, które aktualnie są zatrzymane | int |
servers.warnings | Liczba problemów wykrytych w tej chwili | int |
monitorings.count | Liczba monitorów | int |
monitorings.type | Typ monitora | string |
{
Operacja "get-company-projects"
Pobiera informacje o projektach.
Metoda | POST |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.get-company-projects | Odpowiedni typ operacji | string | Tak |
Parametr | Opis | Format |
---|---|---|
data | Tablica z listą projektów | array |
{
Operacja "get-outages"
Pobieranie listy awarii
Metoda | POST |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.get-outages | Odpowiedni typ operacji | string | Tak |
data.start | Numer rekordu, od którego należy rozpocząć pobieranie danych. min 1 | int | Tak |
data.limit | Limit ilości zwracanych danych. min 10, max 1000 | int | Tak |
data.dateFrom | Data "od" pobieranych danych | yyyy-mm-dd | Tak |
data.dateTo | Data "do" pobieranych danych | yyyy-mm-dd | Tak |
data.type | Wybrany typ danych. Dozwolone typy: "outages" lub "current" | string | Tak |
data.projects | Filtrować dane według projektów. Podaj "projectId" przez przecinek | string | Nie |
data.monitors | Filtrować dane według monitorów. Podaj "monitorId" przez przecinek | string | Nie |
data.domains | Filtrować dane według domen. Podaj "domainID" przez przecinek | string | Nie |
data.servers | Filtrować dane według serwerów. Podaj "serverID" przez przecinek | string | Nie |
Parametr | Opis | Format |
---|---|---|
recordsTotal | Suma rekordów | int |
page | Bieżąca strona | int |
rows | Limit ilości zwracanych danych | int |
totalPages | Wszystkie strony | int |
data[i].outageId | Identyfikator awarii | int |
data[i].isSuccess | Status testu | int |
data[i].startedAt | Data i godzina wykrycia awarii | yyyy-mm-dd hh:mm:ss |
data[i].endedAt | Data i godzina zakończenia awarii | yyyy-mm-dd hh:mm:ss |
data[i].monitorId | Identyfikator monitora, którego awaria dotyczy | int |
data[i].monitorName | Nazwa monitora | string |
data[i].reasonCode | Kod statusu awarii | int |
data[i].reasonDetails | Szczegóły przyczyny awarii | string |
data[i].duration | Czas trwania awarii | string |
data[i].image | Screenshot awarii | string |
data[i].harFile | Plik har zawierający wszystkie dane żądań | string |
data[i].headers | Wszystkie nagłówki odpowiedzi | array |
{
Operacja "get-outage"
Pobiera szczegóły awarii.
Metoda | POST |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.get-outage | Odpowiedni typ operacji | string | Tak |
data.outageId | Identyfikator awarii | int | Tak |
Parametr | Opis | Format |
---|---|---|
data | Opis w dziale "get-outages" | array |
tests | Lista ostatnich testów wykonanych w trakcie trwania awarii | array |
tests.isSuccess | Status testu | int |
tests.reasonCode | Kod statusu awarii | int |
tests.reasonDetails | Dodatkowe informacja dot. przyczyny awarii, np. słowo kluczowe, które nie zostało znalezione w kodzie HTML strony | string |
tests.responseTime | Czas odpowiedzi | float |
tests.date | Data wykonania testu | yyyy-mm-dd hh:mm:ss |
notifications | Lista wysłanych powiadomien z powodu awarii | array |
notifications.event | Zdarzenie | string |
notifications.type | Odbiorca powiadomienia | string |
notifications.date | Data wysłania powiadomienia | yyyy-mm-dd hh:mm:ss |
{
Operacja "get-monitors"
Pobiera listę wszystkich monitorów, wraz z podstawowymi informacjami.
Metoda | POST |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.get-monitors | Odpowiedni typ operacji | string | Tak |
data.start | Numer rekordu, od którego należy rozpocząć pobieranie danych. min 1 | int | Tak |
data.limit | Limit ilości zwracanych danych. min 10, max 1000 | int | Tak |
Parametr | Opis | Format |
---|---|---|
data | Tablica z listą pobranych monitorów | array |
data.monitorId | Identyfikator monitora | int |
data.name | Nazwa monitora | string |
data.status | Status monitora. ACTIVE, INACTIVE, DELETED | int |
data.type | Typ monitora | string |
data.createdAt | Data dodania | yyyy-mm-dd |
data.currentErrorDate | Data ostatniego błędu | yyyy-mm-dd hh:mm:ss lub null |
data.currentOutageId | Identyfikator aktualnie trwającej awarii | int lub null |
data.lastRunDate | Data ostatniego uruchomienia | yyyy-mm-dd hh:mm:ss |
data.numOfLaunches | Liczba uruchomień | int |
{
Operacja "update-monitor"
Wznawia lub wstrzymuje monitoring wskazanego monitora
Metoda | PATCH |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.update-monitor | Odpowiedni typ operacji | string | Tak |
data.monitorId | Identyfikator monitora | int | Tak |
data.command | Polecenie: "start" lub "pause" | string | Tak |
Parametr | Opis | Format |
---|---|---|
ResponseCode | Kod statusu odpowiedzi | int |
ResponseText | Opis słowny statusu odpowiedzi | string |
Operacja "get-data"
Pobiera dane o dostępności i czasie odpowiedzi wskazanego monitora.
Metoda | POST |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.get-data | Odpowiedni typ operacji | string | Tak |
monitorId | Identyfikator monitora | int | Tak |
data.start | Numer rekordu, od którego należy rozpocząć pobieranie danych. min 1 | int | Tak |
data.limit | Limit ilości zwracanych danych. min 10, max 1000 | int | Tak |
data.dateFrom | Data "od" pobieranych danych | yyyy-mm-dd | Tak |
data.dateTo | Data "do" pobieranych danych | yyyy-mm-dd | Tak |
Parametr | Opis | Format |
---|---|---|
data | Tablica z danymi pogrupowanymi wg daty | array |
data.date | Data grupy danych | yyyy-mm-dd hh:mm:ss |
data.uptime | Dostępność, 0-100% | float |
data.responseTime | Czas odpowiedzi, sekundy | float |
{
Operacja "get-domains-list"
Pobiera listę wszystkich domen użytkownika
Metoda | POST |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.get-domains-list | Odpowiedni typ operacji | string | Tak |
data.start | Numer rekordu, od którego należy rozpocząć pobieranie danych. min 1 | int | Tak |
data.limit | Limit ilości zwracanych danych. min 10, max 1000 | int | Tak |
data.search | Przeszukuj domeny według adresu URL, używane jest wyszukiwanie LIKE | string | Nie |
data.filters | Filtrować dane według projektów. Podaj "projectId" przez przecinek | string | Nie |
Parametr | Opis | Format |
---|---|---|
data | Tablica z listą pobranych domen | array |
data.id | Identyfikator domeny | string |
data.url | URL domeny | string |
data.projects | Identyfikator projektu | string |
data.serverId | Identyfikator serwera | string |
data.serverIp | IP serwera | string |
data.description | Pełny opis | string |
data.endedAt | WHOIS data | array |
data.endedAt.date | Data wygaśnięcia domeny | yyyy-mm-dd |
data.endedAt.days | Dni do wygaśnięcia domeny | int |
data.sslEndedAt | SSL data | array |
data.sslEndedAt.date | Data wygaśnięcia SSL | yyyy-mm-dd |
data.sslEndedAt.days | Dni do wygaśnięcia SSL | int |
data.monitorings | Tablica z danymi dla monitorów | array |
data.monitorings.total | Liczba monitorów | int |
data.monitorings.working | Liczba monitorów dla domeny, które działają poprawnie | int |
data.monitorings.stopped | Liczba monitorów, które aktualnie są zatrzymane | int |
data.monitorings.warnings | Liczba problemów wykrytych w tej chwili | int |
{
Operacja "get-servers-list"
Pobiera listę wszystkich serwerów użytkownika
Metoda | POST |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.get-servers-list | Odpowiedni typ operacji | string | Tak |
data.start | Numer rekordu, od którego należy rozpocząć pobieranie danych. min 1 | int | Tak |
data.limit | Limit ilości zwracanych danych. min 10, max 1000 | int | Tak |
data.search | Przeszukuj domeny według adresu URL, używane jest wyszukiwanie LIKE | string | Nie |
data.filters | Filtrować dane według projektów. Podaj "projectId" przez przecinek | string | Nie |
Parametr | Opis | Format |
---|---|---|
data | Tablica z listą pobranych serwerów | array |
data.id | Identyfikator serwera | string |
data.ip | IP serwera | string |
data.projects | Identyfikator projektu | string |
data.description | Pełny opis | string |
data.createdAt | Data dodania | yyyy-mm-dd |
data.monitorings | Tablica z danymi dla monitorów | array |
data.monitorings.total | Liczba monitorów | int |
data.monitorings.working | Liczba monitorów dla serwera, które działają poprawnie | int |
data.monitorings.stopped | Liczba monitorów, które aktualnie są zatrzymane | int |
data.monitorings.warnings | Liczba problemów wykrytych w tej chwili | int |
{
Operacja "get-payments"
Pobiera dane o zamówieniach
Metoda | POST |
Parametr | Opis | Format | Wymagany |
---|---|---|---|
operation.get-payments | Odpowiedni typ operacji | string | Tak |
data.start | Numer rekordu, od którego należy rozpocząć pobieranie danych. min 1 | int | Tak |
data.limit | Limit ilości zwracanych danych. min 10, max 1000 | int | Tak |
Parametr | Opis | Format |
---|---|---|
data | Tablica z listą pobranych zamówień | array |
orderId | Zamówienie # | int |
createdAt | Data dodania | yyyy-mm-dd hh:mm:ss |
processedAt | Data płatności | yyyy-mm-dd hh:mm:ss |
amount | Kwota płatności | double |
currency | Waluta | string |
status | Status | string |
description | Opis | string |
download | Link do pobrania faktury VAT w formacie PDF | string |
{