summaryrefslogtreecommitdiffstats
path: root/data/www/2.html
blob: 95afd26ee9c1aa522f840f6949457d3b35b31fb3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
<head>
<meta charset=UTF-8>
<link rel="stylesheet" type="text/css" href="css/main.css">
</head>
<b><text style=font-size:25px>Dokumentacija API klicev prek HTTP strežnika</text><!--	<img align=right src=img.png alt=SLIKA width=300 height=170 />-->
<br><i>Anton Luka Šijanec, 13. december 2019</i><br></b>
<p>
Klici se delajo z GET ali POST zahtevami na virtualno podmapo strežnika /api/<br>
Kot argumente uporabimo argumente z vrednostmi po RFC specifikaciji, bodi si v URI-ju ali v POST telesu.<br>
Priporočam uporabo GET zahtev, saj zafrkavanje z Content-Length headerji ni potrebno.
</p><p>
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.<br>
Priporočam, da geslo pred priklopom v večjo mrežo ali internet spremenite.<br>
Sprememba gesla: prek FTP strežnika, datoteka /403/webgeslo.txt ali z API ukazom /api/pwd?g=novogeslo<br>
</p><p>
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.<br>
</p><p>
NUJNO! pri API ukazu ne napišite zadnje poševnice, /api/pwd ni isto kot /api/pwd/, slednja bo vrnila <i>404: Napačen ukaz ali napačno ime datoteke.</i>
</p><p>
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 <i>400: Napačna zahteva</i> 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.
</p><p>
<pre>
  <a href=/api/pin>/api/pin - ročna nastavitev pinov (branje in pisanje)</a>
  <a href=/api/res>/api/res - prikaz resursov sistema</a>
  <a href=/api/sap>/api/sap - nastavitev dostopne točke</a>
  <a href=/api/sta>/api/sta - priklop na drugo dostopno točko</a>
  <a href=/api/gid>/api/gid - pridobi informacije o napravi in o omrežju</a>
  <a href=/api/pwm>/api/pwm - nastavi frekvenco pulzoširinske modulacije (brez argumentov pove trenutno vrednost)</a>
  <a href=/api/rst>/api/rst - znova zažene sistem in programje (brez argumentov)</a>
  <a href=/api/slp>/api/slp - globoko spanje za n mikrosekund</a>
  <a href=/api/now>/api/now - vrne podatek o trenutnem času v obliki UNIX časovnega žiga (brez argumentov)</a>
  <a href=/api/pwd>/api/pwd - sprememba gesla</a>
  <a href=/api/tms>/api/tms - nastavitev časa (ob povezavi v splet se čas sicer vsakih 300 sekund posodobi iz 0.pool.ntp.org)</a>
  <a href=/api/ren>/api/ren - preimenovanje datotek, pod "haubo" isto kot /api/mov</a>
  <a href=/api/mov>/api/mov - premikanje datotek, pod "haubo" isto kot /api/ren</a>
  <a href=/api/fil>/api/fil - nastavljanje vrednosti datoteke</a>
  <a href=/api/fil>/api/tud - vsili posodobitev časa</a>
  <a href=/api/fil>/api/upload - POST nalaganje datoteke</a>
  
  <a href=/test>/test - vedno vrne 200: OK, za namen testiranje povezave, npr. če je kontrolna plošča še vedno povezana na napravo.</a>
</pre>
</p><hr>
Preberi še: <a href=2.html>Dokumentacija API klicev prek HTTP strežnika</a>