Dokumentacija API klicev prek HTTP strežnika
Anton Luka Šijanec, 13. december 2019

Klici se delajo z GET ali POST zahtevami na virtualno podmapo strežnika /api/
Kot argumente uporabimo argumente z vrednostmi po RFC specifikaciji, bodi si v URI-ju ali v POST telesu.
Priporočam uporabo GET zahtev, saj zafrkavanje z Content-Length headerji ni potrebno.

Vse zahteve so avtenticirane z uporabo WWW-Authentication standarda z geslom, ki ga nastavite po meri. Uporabniško ime je sijaneciot (oziroma program_ime, če to spremenljivko spremenite), geslo pa lahko spreminjate in je privzeto prav tako nastavljeno na program_ime.
Priporočam, da geslo pred priklopom v večjo mrežo ali internet spremenite.
Sprememba gesla: prek FTP strežnika, datoteka /403/webgeslo.txt ali z API ukazom /api/pwd?g=novogeslo

Kode napak so standardne, če niste avtenticirani, dobite 401, če je dostop prepovedan je 403, napaka na strani strežnika je 5xx, uporabniška napaka/napaka klienta je 4xx, preusmeritve so 3xx, status OK pa je 2xx.

NUJNO! pri API ukazu ne napišite zadnje poševnice, /api/pwd ni isto kot /api/pwd/, slednja bo vrnila 404: Napačen ukaz ali napačno ime datoteke.

Spodaj so našteti podprti ukazi, za argumente posameznega ukaza pa zahtevajte ukaz brez argumentov. Če argumentov ne navedete in so za izvedbo ukaza potrebni, tako ali tako dobite napako 400: Napačna zahteva in izpiše se vam seznam potrebnih in opcijskih argumentov, razen če ni drugače navedeno; na primer ukaz /api/rst ne potrebuje argumentov in takoj ponovno zažene sistem.

  /api/pin - ročna nastavitev pinov (branje in pisanje)
  /api/res - prikaz resursov sistema
  /api/sap - nastavitev dostopne točke
  /api/sta - priklop na drugo dostopno točko
  /api/gid - pridobi informacije o napravi in o omrežju
  /api/pwm - nastavi frekvenco pulzoširinske modulacije (brez argumentov pove trenutno vrednost)
  /api/rst - znova zažene sistem in programje (brez argumentov)
  /api/slp - globoko spanje za n mikrosekund
  /api/now - vrne podatek o trenutnem času v obliki UNIX časovnega žiga (brez argumentov)
  /api/pwd - sprememba gesla
  /api/tms - nastavitev časa (ob povezavi v splet se čas sicer vsakih 300 sekund posodobi iz 0.pool.ntp.org)
  /api/ren - preimenovanje datotek, pod "haubo" isto kot /api/mov
  /api/mov - premikanje datotek, pod "haubo" isto kot /api/ren
  /api/fil - nastavljanje vrednosti datoteke
  /api/tud - vsili posodobitev časa
  /api/upload - POST nalaganje datoteke
  
  /test - vedno vrne 200: OK, za namen testiranje povezave, npr. če je kontrolna plošča še vedno povezana na napravo.


Preberi še: Dokumentacija API klicev prek HTTP strežnika