Ta dokumentacija opisuje vse metode API za naslednja dejanja:

• pridobivanje seznamov predmetov (metoda seznama)
• filtriranje seznama (metoda seznama s podatki filtra)
• pridobivanje podrobnih informacij o predmetu (pokaži metoda)
• pridobivanje podatkov za obrazec za dodajanje predmeta (metoda dodajanja)
• shranjevanje podatkov kot nov objekt (metoda shranjevanja)
• pridobivanje podatkov za obrazec za posodobitev objekta (metoda urejanja)
• shranjevanje podatkov posodobljenega predmeta (metoda posodobitve)

API sprejema samo zahteve z omejenega seznama naslovov IP (na primer s strani strankinega računa ali mesta zaledne pisarne).

Vsaka zahteva za API z naslova IP, ki ni na seznamu dovoljenih, bo zavrnjena.

To se naredi za preprečevanje napadov DDoS na API, poskusov ponarejanja zahtev in hekerskih eksperimentov.

Uporabniki vedno dostopajo do javnega spletnega mesta platforme ( pisarna stranke ali zaledna pisarna ) in ta stran sama zahteva potrebne podatke iz API-ja platforme. Ker je naslov IP spletnega mesta fiksen, bo na seznamu dovoljenih.

Vse zahteve API so narejene z naslednjimi metodami HTTP:

• GET za seznam, prikaz, dodajanje in urejanje
• POST za trgovino
• PUT za posodobitev
• DELETE za brisanje

Vsak razdelek API-ja vsebuje URL, na katerega je poslana zahteva za pridobitev ustreznih podatkov.

Metoda zahteve HTTP je določena pred vsakim URL-jem.

Vsaka zahteva API mora vedno vsebovati 4 spremenljivke:

1. data (niz json z nizom podatkov za API)
2. user (niz json z nizom podatkov o trenutnem uporabniku)
3. time (trenutni čas v časovnem pasu UTC)
4. hash (digitalni podpis v obliki zgoščenke za preverjanje, da je zahteva za API zagotovo iz pooblaščenega vira)

Če je zahteva uspešna, API vedno vrne dve spremenljivki:

1. status = true (stanje uspeha)
2. data (niz json z nizom podatkov iz API-ja)

Če zahteva ne uspe, API pokaže spremenljivke:

1. status = false (stanje napake)
2. error (besedilni niz, ki opisuje napako)

Vsaka zahteva API mora vsebovati spremenljivko hash, ki je digitalni podpis zahteve.

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

• md5, sha256, bcrypt — razpoložljivih algoritmov šifriranja
• $json — json niz s podatki zahteve
• $time — čas v obliki "DD.MM.LLLL HH:MM:SS"
• $salt — fiksna edinstvena vrednost ("sol") za API platforme