Ova dokumentacija opisuje sve API metode za sljedeće radnje:

• dobivanje popisa objekata (metoda liste)
• filtriranje popisa (metoda popisa s podacima filtriranja)
• dobivanje detaljnih informacija o objektu (prikaži metoda)
• dobivanje podataka za obrazac za dodavanje objekta (metoda dodavanja)
• spremanje podataka kao novog objekta (metoda pohrane)
• dobivanje podataka za obrazac za ažuriranje objekta (metoda uređivanja)
• spremanje podataka ažuriranog objekta (metoda ažuriranja)

API prihvaća samo zahtjeve s ograničenog popisa IP adresa (na primjer, sa stranice računa klijenta ili web-mjesta pozadinskog ureda).

Svaki zahtjev API-ju s IP adrese koja nije na popisu dopuštenih bit će odbijen.

To je učinjeno kako bi se spriječili DDoS napadi na API, pokušaji krivotvorenja zahtjeva i hakerski eksperimenti.

Korisnici uvijek pristupaju javnoj stranici platforme (korisnički ured ili back office), a ova stranica sama traži potrebne podatke od API-ja platforme. Budući da je IP adresa stranice fiksna, bit će na popisu dopuštenih.

Svi API zahtjevi izrađuju se pomoću sljedećih HTTP metoda:

• GET za popis, prikaz, dodavanje i uređivanje
• POST za trgovinu
• PUT za ažuriranje
• DELETE za brisanje

Svaki odjeljak API-ja sadrži URL na koji se postavlja zahtjev za dobivanje relevantnih podataka.

Metoda HTTP zahtjeva navedena je ispred svakog URL-a.

Svaki API zahtjev uvijek mora sadržavati 4 varijable:

1. data (json niz s nizom podataka za API)
2. user (json niz s nizom podataka o trenutnom korisniku)
3. time (trenutačno vrijeme u UTC vremenskoj zoni)
4. hash (digitalni potpis u obliku hasha za provjeru da je zahtjev za API-jem definitivno iz ovlaštenog izvora)

Ako je zahtjev uspješan, API uvijek vraća dvije varijable:

1. status = true (uspješan status)
2. data (json niz s nizom podataka iz API-ja)

Ako zahtjev ne uspije, API prikazuje varijable:

1. status = false (status pogreške)
2. error (tekstualni niz koji opisuje pogrešku)

Svaki API zahtjev mora sadržavati hash varijablu koja je digitalni potpis zahtjeva.

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

• md5, sha256, bcrypt — dostupnim algoritmima šifriranja
• $json — json niz s podacima zahtjeva
• $time — vrijeme u formatu "DD.MM.GGGG HH:MM:SS"
• $salt — fiksna jedinstvena vrijednost ("sol") za API platforme