ALGO RESTful API

Vöruupplýsingar: RESTful API Guide

Algo RESTful API gerir notendum kleift að fá aðgang að, vinna með og kveikja á aðgerðum á Algo IP endapunktum á netinu sínu í gegnum HTTP/HTTPS beiðnir. Þetta skjal veitir samræmda og fyrirfram skilgreinda mengi ríkisfangslausra aðgerða sem hægt er að nota til að hafa samskipti við Algo tæki. API styður HTTP/HTTPS GET, POST og PUT beiðnir með JSON hleðslu.

Auðkenning

Það eru þrjár gerðir af auðkenningum í boði með Algo RESTful API:

• Hefðbundin auðkenning (virkjað sjálfgefið)
• Grunn auðkenning (valfrjálst)
• Engin auðkenningaraðferð (ekki mælt með; aðeins í prófunarskyni)

Notkunarleiðbeiningar fyrir vöru: RESTful API

Forkröfur

Áður en RESTful API er virkjað skaltu ganga úr skugga um að tækið sé með nettengingu til að ná í fyrirfram stillta NTP netþjóna. Ef engin nettenging er tiltæk skaltu stilla staðbundinn NTP netþjón og slá inn IP tölu hans.

Virkjar RESTful API

1. Skráðu þig inn á tækið web viðmóti og farðu í Admin flipann Advanced Settings.
2. Skrunaðu niður í API-stuðningshlutann og virkjaðu RESTful API.
3. Stilltu lykilorðið sem þú vilt (sjálfgefið lykilorð: algo). Athugaðu að staðlað auðkenning er sjálfgefið virkt.

Virkja grunnauðkenningu (valfrjálst)

1. Í web viðmót, farðu í System Maintenance flipann og halaðu niður stillingunum file.
2. Opnaðu stillingarnar file með hvaða textaritli sem er og bættu við eftirfarandi línu: api.auth.basic = 1
3. Vistaðu og hladdu upp breyttu stillingunum file aftur í tækið með því að nota Restore Configuration File eiginleiki í System Maintenance flipanum.

Virkja engin auðkenningaraðferð (valfrjálst)

Til að virkja aðferðina án auðkenningar skaltu skilja reitinn RESTful API lykilorð eftir auðan. Ekki er mælt með þessari aðferð og ætti aðeins að nota í prófunartilgangi þar sem hún veitir ekkert öryggi.

Virkja einfalt stjórnviðmót (valfrjálst)

1. Á web viðmót, farðu í System Maintenance flipann og halaðu niður stillingunum file.
2. Opnaðu stillingarnar file nota textaritil og bæta við tveimur línum. Breyttu lykilorðinu sem þú vilt.
3. Admin.web.sci = 1
4. Sci.admin.pwd =
5. Vistaðu og hladdu upp breyttu stillingunum file aftur í tækið með því að nota Restore Configuration File eiginleiki í System Maintenance flipanum.

Auðkenning Sampkóðann

Vinsamlegast sendu tölvupóst support@algosolutions.com ef þú vilt staðlaða eða grunn auðkenningu sampkóðann.
Fyrir frekari aðstoð, hringdu 604-454-3792 eða tölvupósti support@algosolutions.com

Upplýsingatilkynningar

Athugið
Athugið gefur til kynna gagnlegar uppfærslur, upplýsingar og leiðbeiningar sem ætti að fylgja

Fyrirvari

Talið er að upplýsingarnar í þessu skjali séu réttar í hvívetna en Algo ábyrgist ekki. Upplýsingarnar geta breyst án fyrirvara og ætti ekki að túlka þær á nokkurn hátt sem skuldbindingar af hálfu Algo eða einhverra hlutdeildarfélaga þess eða dótturfélaga. Algo og hlutdeildarfélög þess og dótturfélög bera enga ábyrgð á villum eða vanrækslu í þessu skjali. Endurskoðanir á þessu skjali eða nýjar útgáfur þess kunna að vera gefnar út til að taka upp slíkar breytingar. Algo tekur enga ábyrgð á tjóni eða kröfum sem stafa af notkun þessarar handbókar eða slíkra vara, hugbúnaðar, fastbúnaðar og/eða vélbúnaðar. Engan hluta þessa skjals má afrita eða senda á nokkurn hátt eða með neinum hætti - rafrænum eða vélrænum - í neinum tilgangi án skriflegs leyfis frá Algo.
Fyrir frekari upplýsingar eða tæknilega aðstoð í Norður-Ameríku, vinsamlegast hafðu samband við þjónustudeild Algo:

Algo tækniaðstoð
1-604-454-3792
support@algosolutions.com

©2022 Algo er skráð vörumerki Algo Communication Products Ltd.
Allur réttur áskilinn. Öll önnur vörumerki eru eign viðkomandi eigenda. Allar forskriftir geta breyst án fyrirvara.

 ALMENNT

Inngangur

Þetta skjal lýsir því hvernig hægt er að nota Algo RESTful API til að fá aðgang að, meðhöndla og koma af stað aðgerðum á Algo IP endapunktum á netinu þínu í gegnum HTTP/HTTPS beiðnir, sem og nokkrar mismunandi auðkenningaraðferðir með mismunandi öryggisstigum. Beiðnikerfi geta haft samskipti við Algo tæki með samræmdu og fyrirfram skilgreindu mengi ríkisfangslausra aðgerða sem skilgreindar eru í þessu skjali. Beiðnir eru gerðar til vefslóðar auðlindar með JSON hleðslu og kalla fram JSON svar. HTTP/HTTPS GET, POST og PUT beiðnir eru gerðar til að tilföng URI ásamt JSON hleðslu (sjá skipanahlutann til að fá lista yfir hleðslur).

 Auðkenning

Það eru þrjár gerðir af auðkenningum:

•  Standard (mælt með)
•  Basic
•  Engin (ekki mælt með)

Staðlaða auðkenningin notar Hash-based Message Authentication Code (HMAC) með SHA-256 kóðuðu samantekt. Grunn auðkenning notar Base64 kóðun og ætti aðeins að nota yfir HTTPS. Engin auðkenning ætti aðeins að nota með mikilli varkárni þar sem hún veitir enga auðkenningu. Sjá kaflann Auðkenningarkröfur fyrir frekari upplýsingar.

UPPSETNING OG UPPSETNING

Forkröfur

•  Þetta skjal gerir ráð fyrir að Algo endapunkturinn sé að keyra vélbúnaðarútgáfu 3.3 eða nýrri.
•  Tímamunurinn á milli beiðanda og Algo tækjanna ætti að vera innan við 30 sekúndur til að nota staðlaða auðkenningu.
• Gakktu úr skugga um að NTP (Network Time Protocol) sé í notkun. Heimilisföng sérsniðinna NTP netþjóna má stilla í flipanum Ítarlegar stillingar → Tími.

Athugið
Forstilltu NTP netþjónarnir eru hýstir opinberlega og því þarf nettenging til að ná honum. Ef engin nettenging er tiltæk skaltu stilla staðbundinn NTP netþjón og slá inn IP tölu hans.

• Gakktu úr skugga um að kerfistími Algo tækisins sé stilltur að réttu tímabelti. Þetta er hægt að gera með því að fara í Advanced Settings → Time flipann.

 Virkjar RESTful API

1. Skráðu þig inn á web viðmóti og farðu í Advanced Settings → Admin flipann.
2. Skrunaðu niður í API-stuðningshlutann, virkjaðu RESTful API og stilltu lykilorðið eins og þú vilt (sjálfgefið lykilorð: algo)
   Athugið
   Hefðbundin auðkenning er sjálfkrafa virkjuð.

Virkja grunnauðkenningu (valfrjálst)

1. Í web viðmót, farðu í Kerfi → Viðhald flipann og halaðu niður stillingunum file.
2. Opnaðu stillingarnar file með hvaða textaritli sem er og bættu við eftirfarandi línu: api.auth.basic = 1
3.  Vistaðu og hladdu upp breyttu stillingunum file aftur í tækið með því að nota Restore Configuration File eiginleiki í Kerfi → Viðhald flipann.

Engin auðkenningaraðferð (valfrjálst)

Til að virkja aðferðina án auðkenningar skaltu skilja reitinn RESTful API lykilorð eftir auðan. Ekki er mælt með þessari aðferð og ætti aðeins að nota í prófunartilgangi þar sem hún veitir ekkert öryggi.

Virkja einfalt stjórnviðmót (valfrjálst)

1. Á web viðmót, farðu í Kerfi → Viðhald flipann og halaðu niður stillingunum file.
2.  Opnaðu stillingarnar file nota textaritil og bæta við tveimur línum. Breyttu að lykilorði þínu sem þú vilt. Admin.web.sci = 1
   Sci.admin.pwd =
3.  Vistaðu og hladdu upp breyttu stillingunum file aftur í tækið með því að nota Restore Configuration File eiginleiki í Kerfi → Viðhald flipann.

Auðkenningarkröfur

Vinsamlegast sendu tölvupóst support@algosolutions.com ef þú vilt staðlaða eða grunn auðkenningu sampkóðann.

Hefðbundin auðkenningarbeiðni með JSON hleðslu

Nauðsynlegir hausar í HTTP/HTTPS beiðni
> Efnistegund: „application/json“
> Efni-MD5: [content_md5] Dæmiample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Heimild: hmac admin:[nonce]:[hmac_output]
Heimildarhausarnir samanstanda af:

1. Strenginn 'hmac admin' á eftir tvípunkti ':'.
2. Nonce – Handahófskennt eða óendurtekið gildi, fylgt eftir með tvípunkti ':'.
3. Hmac_output – myndað af RESTful API lykilorðinu (leynilykill) stillt á tækinu þínu og HMAC inntakinu, eins og hér að neðan:
   [request_method]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[ekkert]

HMAC inntak tdample: (notar 'algo' sem leynilykil)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Búðu til HMAC með lykilorði og HMAC inntaksstreng sem samantekt með SHA-256:
HMAC framleiðsla tdample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Dagsetning: dagur, dagsetning mánuður, ár klst:mín:sek GMT
Example
Dagsetning: Fim, 22. september, 2022 02:33:07 GMT
Hefðbundin auðkenning með hleðslu tdample:

 Hefðbundin auðkenningarbeiðni án JSON farms

Eins og 3.1 með innihaldstengdum hausum/hmac inntaki sleppt.
HMAC inntak: [request_method]:[request_uri]:[timestamp]:[ekkert] HMAC inntak tdample: (notar 'algo' sem leynilykil)
GET:/api/settings/audio.page.vol:1601312252:49936
Búðu til HMAC með lykilorði og HMAC inntaksstreng með SHA-256:
HMAC framleiðsla tdample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Hefðbundin auðkenning án hleðslu tdample:

 Grunnstaðfestingarbeiðni

Þessa auðkenningaraðferð ætti að nota með varúð þar sem hún er óöruggari en staðlaða aðferðin.

Heimild: Basic [base64]
Example:
Heimild: Basic YWRtaW46YWxnbwo=
Grunn auðkenning tdample:

Skipanir

 RESTful API skipanir

Hér að neðan er listi yfir allar studdar API skipanir.

Athugið
PUT beiðni breytir eða býr til varanlega auðlind sem lifir af endurræsingu, á meðan POST beiðni stjórnar aðeins tækinu fyrir núverandi lotu.

Lýsing	Aðferð	URI	Burðargeta Færibreytur	Til baka Example	Vara	FW
Sækja gildi tiltekinnar færibreytu.	FÁ	/api/settings/[lyklanafn] Dæmi./api/settings/audio.page.vol	N/A	{“audio.page.vol”: „-18dB“}	Allt	> 3.3
Skilaðu umhverfishljóðstigi mælt í desibel. Umhverfishávaðabætur verða að vera virkjaðar í Grunnstillingum -> Eiginleikar flipann.	FÁ	/api/info/audio.noise.level	N/A	{“audio.noise.level”: 72}	Hátalarar Sýna hátalara	> 3.3
Dragðu út stöðu gengisinntakstengis.	FÁ	/api/info/input.relay.status	N/A	{“input.relay.status”: “idle”} eða {“input.relay.status”: “active”}	Allar vörur með relay input, nema 8063. Sjá hér að neðan.	> 4.1
Dragðu út stöðu inntak 1 eða inntak 2 skautanna.	FÁ	/api/info/input.relay1.status eða /api/info/input.relay2.status	N/A	{“input.relay1.status”: “idle”} eða {“input.relay1.status”: “active”}	8063	> 4.1
Sæktu lista yfir tón fileer nú uppsett.	FÁ	/api/info/tonelist	N/A	{“tónlisti“:[“bjalla-na.wav”,,”bjalla uk.wav”,,”buzzer.wav”,…]}	Allt	> 5.0
Sæktu upplýsingar um tækið sem birtast á stöðusíðunni.	FÁ	/api/info/staða	N/A	Allur listi yfir upplýsingar frá Status flipanum.	Allt	> 5.4

Sæktu vöruupplýsingarnar sem birtast á síðunni Um.	FÁ	/api/info/about	N/A	Allar upplýsingar eru á flipanum Um.	Allt	> 5.4
Virkjaðu strobe með viðeigandi lita- og mynsturbreytum.	POST	/api/controls/strobe/start	mynstur: {0 – 15} litur1: {blár, rauður, gulur, grænn} litur2: {blár, rauður, gulur, grænn} ledlvl: {1 – 255} yfirvegun: {satt, ósatt}	N/A	8128(G2) 8138 8190S	> 3.3
Hættu strobe.	POST	/api/controls/strobe/stopp	N/A	N/A	8128(G2) 8138 8190S	> 3.3
Spilaðu tón einu sinni eða taktu hann.	POST	/api/stýringar/tónn/byrjun	slóð: {tónn} þ.e. chime.wav lykkja: {true, false} eða {0, 1} td {„slóð“:“chime.wav“, „lykkja“:true}	N/A	Hátalarar 8301 8373 8028(G2) 8201 8039	> 3.3
Hættu tóninum.	POST	/api/stýringar/tónn/stopp	N/A	N/A	Hátalarar 8301 8373 8028(G2) 8201 8039	> 3.3
Hringdu í símanúmer með fyrirfram tekin skilaboð.	POST	/api/controls/call/start	{“extension”:”2099″, „tónn“:“gong.wav“, „bil“:“0″, „maxdur“:“10″}	N/A	Hátalarar 8301 8410 8420	> 3.3
Ljúktu símtalinu.	POST	/api/controls/call/stop	N/A	N/A	Hátalarar 8301 8410 8420	> 3.3

Hefja einstefnusímtal. Tækið mun taka á móti hljóðstraumi frá markviðbót.	POST	/api/controls/call/page	{"viðbót":" ”}	N/A	Hátalarar 8410 8420	> 5.3.4
Endurræstu markendapunktinn.	POST	/api/controls/endurræsa	N/A	N/A	Allt	> 3.3
Opnaðu hurðina. „local“ stjórnar staðbundnu genginu „netdc1“ stjórnar ytri nethurðarstýringu (8063)	POST	/api/controls/door/opnaðu	doorid: {local, netdc1} * Valfrjálst	N/A	8039 8028(G2) 8201 8063	> 3.3
Læstu hurðinni.	POST	/api/stýringar/hurð/lás	doorid: {local, netdc1} * Valfrjálst	N/A	8039 8028(G2) 8201 8063	> 3.3
Virkjaðu 24v aux out relay.	POST	api/controls/24v/enable	N/A	N/A	8063	> 5.0
Slökktu á 24v aux out relay.	POST	api/stýringar/24v/slökkva	N/A	N/A	8063	> 5.0
Virkjaðu úttaksgengið.	POST	/api/controls/relay/enable	N/A	N/A	8063	> 5.0
Slökktu á úttaksgenginu.	POST	/api/controls/relay/disable	N/A	N/A	8063	> 5.0
Athugaðu vélbúnaðarþjóninn Algo fyrir nýjustu vélbúnaðarútgáfuna.	POST	/api/controls/upgrade/check	N/A	{“version”: “updated”} eða {“version”: “ ”}	Allt	> 4.1
Athugaðu fastbúnaðarþjóninn Algo fyrir nýjustu vélbúnaðarútgáfuna og uppfærðu í þá útgáfu.	POST	/api/controls/upgrade/start	N/A	{“status”: “updated”} eða {“status”: “uppfærsla ”, “url”: url>} eða {“staða”: “ ”}	Allt	> 4.1
Birta mynd eða mynstur á skjánum.	POST	/api/stýringar/skjár/byrjun	Sjá fyrir neðan	N/A	8410 8420	> 5.3.4
Stöðvaðu skjámynstrið og farðu aftur á sjálfgefna skjáinn.	POST	/api/stýringar/skjár/stopp	N/A	N/A	8410 8420	> 5.3.4

Endurræstu aðalforritið.	POST	/api/controls/reload	N/A	N/A	Allt	> 5.3.4
Byrjaðu að hlusta á beinan hljóðstraum. Stilltu gáttarnúmerið sem straumurinn er sendur til.	POST	/api/controls/rx/start	{"höfn": }	N/A	Allt	> 5.3.4
Hættu að hlusta á beinan hljóðstraum.	POST	/api/controls/rx/stopp	N/A	N/A	Allt	> 5.3.4
Stilltu fjölvarpsstillinguna.	SETJA	/api/state/mcast/update/	{“hamur”:”sendi”, “address”: , "höfn": , "type":"rtp"} eða {"mode":"sender", "address": , "höfn": , “type”:”poly”, “group”:1} **Athugið**: Ef stýringar/tónn/byrjun er notuð á undan þessari skipun mun tónninn spilast með núverandi stillingum á web HÍ.	N/A	8301	> 5.0
Settu gildi í tiltekna færibreytu úr JSON-hleðslu.	SETJA	/api/stillingar	færibreyta: {gildi} td {“audio.page.vol”: “-3dB”}	N/A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Einfalt stjórnviðmót (SCI) skipanir

Allar SCI skipanir eru GET beiðnir og hafa sameiginlegar breytur „usi“ og „admin“ fyrir auðkenningu.
Example:
FÁ http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Lýsing	URI	Viðbótarupplýsingar Burðargeta Færibreytur	Vörur	FW
Opnaðu hurðina. „local“ stjórnar staðbundnu genginu „netdc1“ stjórnar ytri nethurðarstýringu (8063)	/sci/controls/do eða/opnaðu	doorid: {local, netdc1} * Valfrjálst	8039 8028(G2) 8201 8063	> 3.3
Læstu hurðinni.	/sci/controls/do or/lock	doorid: {local, netdc1} * Valfrjálst	8039 8028(G2) 8201 8063	> 3.3
Spilaðu tón einu sinni eða taktu hann.	/sci/controls/to ne/start	slóð: {tónn} þ.e. chime.wav lykkja: {true, false} eða {0, 1}	Allt	> 3.3
Hættu tóninum.	/sci/controls/to ne/stop	N/A	Allt	> 3.3
Virkjaðu strobe með viðeigandi lita- og mynsturbreytum.	/sci/controls/strobe/start	mynstur: {0 – 15} litur1: {blátt, rautt, gulbrúnt, grænt} litur2: {blár, rauður, gulbrúnn, grænn} ledlvl: {1 – 255} holdover: {true, false}	8128(G2) 8138 8190S	> 3.3
Hættu strobe.	/sci/controls/strobe/stopp	N/A	8128(G2) 8138 8190S	> 3.3

Skjöl / auðlindir

	ALGO RESTful API [pdfNotendahandbók AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful API [pdfNotendahandbók AL061-GU-CP000API-230717, RESTful API, RESTful, API

Heimildir

• Notendahandbók