Ta dokumentacja opisuje wszystkie metody API dla następujących działań:

• pobieranie list obiektów (metoda list)
• filtrowanie list (metoda list z filtrem danych)
• uzyskanie szczegółowych informacji o obiekcie (pokaż metodę)
• pobranie danych do formularza dodawania obiektu (metoda add)
• zapisanie danych jako nowy obiekt (metoda store)
• pobranie danych do formularza aktualizacji obiektu (metoda edit)
• zapisanie danych aktualizowanego obiektu (metoda aktualizacji)

Interfejs API akceptuje tylko żądania z ograniczonej listy adresów IP (na przykład z witryny konta klienta lub witryny zaplecza).

Wszelkie żądania kierowane do interfejsu API z adresu IP, który nie znajduje się na liście dozwolonych, będą odrzucane.

Ma to na celu zapobieganie atakom DDoS na interfejs API, próbom fałszowania żądań i eksperymentom hakerskim.

Użytkownicy zawsze uzyskują dostęp do publicznej strony platformy (biura klienta lub zaplecza), a ta strona sama żąda niezbędnych danych z interfejsu API platformy. Ponieważ adres IP witryny jest stały, znajdzie się ona na liście dozwolonych.

Wszystkie żądania API są realizowane przy użyciu następujących metod HTTP:

• GET do listy, pokazuj, dodawaj i edytuj
• POST do sklepu
• PUT do aktualizacji
• DELETE do usunięcia

Każda sekcja API zawiera adres URL, do którego kierowane jest żądanie uzyskania odpowiednich danych.

Metoda żądania HTTP jest określona przed każdym adresem URL.

Każde żądanie API musi zawsze zawierać 4 zmienne:

1. data (ciąg json z tablicą danych dla API)
2. user (ciąg json z tablicą danych o bieżącym użytkowniku)
3. time (aktualny czas w strefie czasowej UTC)
4. hash (podpis cyfrowy w postaci hasha w celu sprawdzenia, czy żądanie do API pochodzi na pewno z autoryzowanego źródła)

Jeśli żądanie się powiedzie, API zawsze zwraca dwie zmienne:

1. status = true (status powodzenia)
2. data (ciąg json z tablicą danych z API)

Jeśli żądanie się nie powiedzie, API wyświetla zmienne:

1. status = false (stan błędu)
2. error (ciąg tekstowy opisujący błąd)

Każde żądanie API musi zawierać zmienną hash, która jest podpisem cyfrowym żądania.

hash = md5($json . $time . $salt)

• md5, sha256, bcrypt — dostępne algorytmy szyfrowania
• $json — json string z danymi żądania
• $time — czas w formacie „DD.MM.RRRR GG:MM:SS”
• $salt — ustalona unikalna wartość ("sól") dla API platformy