API RESTful ALGO

Gwybodaeth Cynnyrch: Canllaw API RESTful

Mae API Algo RESTful yn caniatáu i ddefnyddwyr gyrchu, trin a sbarduno gweithredoedd ar Algo IP Endpoints ar eu rhwydwaith trwy geisiadau HTTP / HTTPS. Mae'r ddogfen hon yn darparu set unffurf a rhagddiffiniedig o weithrediadau di-wladwriaeth y gellir eu defnyddio i ryngweithio â dyfeisiau Algo. Mae'r API yn cefnogi ceisiadau HTTP/HTTPS GET, POST, a PUT gyda llwythi cyflog JSON.

Dilysu

Mae tri math o ddilysiad ar gael gyda'r Algo RESTful API:

• Dilysu safonol (wedi'i alluogi yn ddiofyn)
• Dilysu sylfaenol (dewisol)
• Dim dull dilysu (nid argymhellir; dim ond at ddibenion profi)

Cyfarwyddiadau Defnydd Cynnyrch: API RESTful

Rhagofynion

Cyn galluogi'r API RESTful, sicrhewch fod gan y ddyfais gysylltiad rhyngrwyd i gyrraedd y gweinyddwyr NTP sydd wedi'u ffurfweddu ymlaen llaw. Os nad oes cysylltiad rhyngrwyd ar gael, ffurfweddwch weinydd NTP lleol a rhowch ei gyfeiriad IP.

Galluogi'r API RESTful

1. Mewngofnodwch i mewn i'r ddyfais web rhyngwyneb a llywio i'r tab Gweinyddol Gosodiadau Uwch.
2. Sgroliwch i lawr i'r adran Cymorth API a galluogi'r API RESTful.
3. Gosodwch y cyfrinair a ddymunir (cyfrinair diofyn: algo). Sylwch fod dilysu safonol wedi'i alluogi yn ddiofyn.

Galluogi Dilysu Sylfaenol (Dewisol)

1. Yn y web rhyngwyneb, llywiwch i'r tab Cynnal a Chadw System a dadlwythwch y ffurfweddiad file.
2. Agorwch y ffurfweddiad file gydag unrhyw olygydd testun ac ychwanegwch y llinell ganlynol: api.auth.basic = 1
3. Cadw a lanlwytho'r cyfluniad wedi'i addasu file yn ôl i'r ddyfais gan ddefnyddio'r Ffurfweddu Adfer File nodwedd yn y tab Cynnal a Chadw System.

Galluogi Dim Dull Dilysu (Dewisol)

Er mwyn galluogi'r dull dim dilysu, gadewch faes Cyfrinair API RESTful yn wag. Nid yw'r dull hwn yn cael ei argymell a dim ond at ddibenion profi y dylid ei ddefnyddio gan nad yw'n darparu unrhyw ddiogelwch.

Galluogi Rhyngwyneb Rheoli Syml (Dewisol)

1. Ar y web rhyngwyneb, llywiwch i'r tab Cynnal a Chadw System a dadlwythwch y ffurfweddiad file.
2. Agorwch y ffurfweddiad file defnyddio golygydd testun ac ychwanegu dwy linell. Newidiwch y cyfrinair i'ch dymuniad.
3. Gweinyddol.web.sci = 1
4. Sci.admin.pwd =
5. Cadw a lanlwytho'r cyfluniad wedi'i addasu file yn ôl i'r ddyfais gan ddefnyddio'r Ffurfweddu Adfer File nodwedd yn y tab Cynnal a Chadw System.

Dilysiad Sample Cod

Anfonwch e-bost cefnogaeth@algosolutions.com os hoffech gael dilysiad safonol neu sylfaenol sampcod le.
Am gefnogaeth ychwanegol, ffoniwch 604-454-3792 neu e-bost cefnogaeth@algosolutions.com

Hysbysiadau Gwybodaeth

Nodyn
Nodyn yn nodi diweddariadau defnyddiol, gwybodaeth, a chyfarwyddiadau y dylid eu dilyn

Ymwadiad

Credir bod y wybodaeth yn y ddogfen hon yn gywir ym mhob ffordd ond nid yw Algo yn gwarantu hynny. Gall y wybodaeth newid heb rybudd ac ni ddylid ei dehongli mewn unrhyw ffordd fel ymrwymiad gan Algo nac unrhyw un o'i gysylltiadau neu is-gwmnïau. Nid yw Algo na'i gwmnïau cysylltiedig na'i is-gwmnïau yn cymryd unrhyw gyfrifoldeb am unrhyw wallau neu hepgoriadau yn y ddogfen hon. Gellir cyhoeddi diwygiadau o'r ddogfen hon neu argraffiadau newydd ohoni i ymgorffori newidiadau o'r fath. Nid yw Algo yn cymryd unrhyw atebolrwydd am iawndal neu hawliadau sy'n deillio o unrhyw ddefnydd o'r llawlyfr hwn neu gynhyrchion, meddalwedd, cadarnwedd a / neu galedwedd o'r fath. Ni ellir atgynhyrchu unrhyw ran o’r ddogfen hon na’i throsglwyddo mewn unrhyw ffurf na thrwy unrhyw fodd – electronig neu fecanyddol – at unrhyw ddiben heb ganiatâd ysgrifenedig gan Algo.
Am wybodaeth ychwanegol neu gymorth technegol yng Ngogledd America, cysylltwch â thîm cymorth Algo:

Cymorth Technegol Algo
1-604-454-3792
cefnogaeth@algosolutions.com

Mae ©2022 Algo yn nod masnach cofrestredig Algo Communication Products Ltd.
Cedwir Pob Hawl. Mae pob nod masnach arall yn eiddo i'w perchnogion priodol. Gall pob manyleb newid heb rybudd.

 CYFFREDINOL

Rhagymadrodd

Mae'r ddogfen hon yn disgrifio sut y gellir defnyddio Algo RESTful API i gyrchu, trin, a sbarduno gweithredoedd ar Algo IP Endpoints ar eich rhwydwaith trwy geisiadau HTTP / HTTPS, yn ogystal â chwpl o wahanol ddulliau dilysu gyda lefelau amrywiol o ddiogelwch. Gall systemau gwneud cais ryngweithio â dyfeisiau Algo trwy set unffurf a rhagddiffiniedig o weithrediadau di-wladwriaeth a ddiffinnir yn y ddogfen hon. Gwneir ceisiadau i URI adnodd gyda llwyth cyflog JSON ac yn cael ymateb JSON. Mae ceisiadau HTTP/HTTPS GET, POST, a PUT yn cael eu gwneud i ddarparu adnoddau ar gyfer URI ynghyd â llwyth tâl JSON (gweler yr adran gorchmynion am restr o lwythi tâl).

 Dilysu

Mae tri math o ddilysiad:

•  Safonol (argymhellir)
•  Sylfaenol
•  Dim (heb ei argymell)

Mae'r dilysiad Safonol yn defnyddio Cod Dilysu Neges sy'n seiliedig ar Hash (HMAC) gyda chrynhoad wedi'i amgodio gan SHA-256. Mae dilysu sylfaenol yn defnyddio amgodio Base64 a dim ond dros HTTPS y dylid ei ddefnyddio. Dim ond gyda gofal eithafol y dylid defnyddio unrhyw ddilysiad gan nad yw'n darparu unrhyw ddilysiad. Gweler yr adran Gofynion Dilysu am ragor o fanylion.

SEFYDLIAD A CHYFFORDDIANT

Rhagofynion

•  Mae'r ddogfen hon yn tybio bod pwynt terfyn Algo yn rhedeg fersiwn firmware 3.3 neu uwch.
•  Dylai'r gwahaniaeth amser rhwng y ceisiwr a'r dyfeisiau Algo fod yn llai na 30 eiliad i ddefnyddio dilysiad safonol.
• Sicrhau bod NTP (Protocol Amser Rhwydwaith) yn cael ei ddefnyddio. Efallai y bydd cyfeiriadau gweinyddwyr NTP arferol yn cael eu ffurfweddu yn y tab Gosodiadau Uwch → Amser.

Nodyn
Mae'r gweinyddwyr NTP sydd wedi'u ffurfweddu ymlaen llaw yn cael eu cynnal yn gyhoeddus, felly mae angen cysylltiad rhyngrwyd i'w gyrraedd. Os nad oes cysylltiad rhyngrwyd ar gael, ffurfweddwch weinydd NTP lleol a rhowch ei gyfeiriad IP.

• Sicrhewch fod amser system dyfais Algo yn cael ei addasu i'r parth amser cywir. Gellir gwneud hyn trwy lywio i'r tab Gosodiadau Uwch → Amser.

 Galluogi'r API RESTful

1. Mewngofnodwch i'r web rhyngwyneb a llywio i'r Gosodiadau Uwch → tab Gweinyddol.
2. Sgroliwch i lawr i'r adran Cymorth API, galluogwch yr API RESTful a gosodwch y Cyfrinair fel y dymunir (cyfrinair diofyn: algo)
   Nodyn
   Mae dilysu safonol wedi'i alluogi yn ddiofyn.

Galluogi Dilysu Sylfaenol (Dewisol)

1. Yn y web rhyngwyneb, llywiwch i'r System → Cynnal a chadw tab a llwytho i lawr y ffurfweddiad file.
2. Agorwch y ffurfweddiad file gydag unrhyw olygydd testun ac ychwanegwch y llinell ganlynol: api.auth.basic = 1
3.  Cadw a lanlwytho'r cyfluniad wedi'i addasu file yn ôl i'r ddyfais gan ddefnyddio'r Ffurfweddu Adfer File nodwedd yn y tab System → Maintenance.

Dim Dull Dilysu (Dewisol)

Er mwyn galluogi'r dull dim dilysu, gadewch faes Cyfrinair API RESTful yn wag. Nid yw'r dull hwn yn cael ei argymell a dim ond at ddibenion profi y dylid ei ddefnyddio gan nad yw'n darparu unrhyw ddiogelwch.

Galluogi Rhyngwyneb Rheoli Syml (Dewisol)

1. Ar y web rhyngwyneb, llywiwch i'r System → Cynnal a chadw tab a llwytho i lawr y ffurfweddiad file.
2.  Agorwch y ffurfweddiad file defnyddio golygydd testun ac ychwanegu dwy linell. Newidiwch y at eich cyfrinair dymuniad. Gweinyddol.web.sci = 1
   Sci.admin.pwd =
3.  Cadw a lanlwytho'r cyfluniad wedi'i addasu file yn ôl i'r ddyfais gan ddefnyddio'r Ffurfweddu Adfer File nodwedd yn y tab System → Maintenance.

GOFYNION DILYSU

Anfonwch e-bost cefnogaeth@algosolutions.com os hoffech gael dilysiad safonol neu sylfaenol sampcod le.

Cais Dilysu Safonol gyda Llwyth Tâl JSON

Penawdau gofynnol yn y cais HTTP/HTTPS
> Math o Gynnwys: “cais/json”
> Cynnwys-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Awdurdodiad: gweinyddwr hmac:[nonce]:[hmac_output]
Mae penawdau'r awdurdodiad yn cynnwys:

1. Y llinyn 'hmac admin' ac yna colon ':'.
2. Nonce – Gwerth ar hap neu werth nad yw'n ailadrodd, ac yna colon ':'.
3. Hmac_output - wedi'i gynhyrchu gan y Cyfrinair API RESTful (allwedd gyfrinachol) wedi'i ffurfweddu ar eich dyfais a'r mewnbwn HMAC, fel y nodir isod:
   [cais_method]:[cais_uri]:[content_md5]:[content_type]:[amseramp]: [dim unwaith]

Mewnbwn HMAC cynample: (gan ddefnyddio 'algo' fel yr allwedd gyfrinachol)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Cynhyrchu HMAC gyda chyfrinair a llinyn mewnbwn HMAC fel crynhoad gan ddefnyddio SHA-256:
Allbwn HMAC cynample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Dyddiad: diwrnod, dyddiad, mis, blwyddyn awr: munud: eiliad GMT
Example
Dyddiad: Dydd Iau, 22 Medi, 2022 02:33:07 GMT
Dilysiad safonol gyda llwyth tâl example:

 Cais Dilysu Safonol Heb Llwyth Tâl JSON

Yn union yr un fath â 3.1 gyda phenawdau cysylltiedig â chynnwys/mewnbwn hmac wedi'i hepgor.
Mewnbwn HMAC: [request_method]:[request_uri]:[timestamp]:[nonce] mewnbwn HMAC example: (gan ddefnyddio 'algo' fel yr allwedd gyfrinachol)
GET:/api/settings/audio.page.vol:1601312252:49936
Cynhyrchu HMAC gyda chyfrinair a llinyn mewnbwn HMAC gan ddefnyddio SHA-256:
Allbwn HMAC cynample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Dilysiad safonol heb lwyth tâl example:

 Cais Dilysu Sylfaenol

Dylid defnyddio'r dull hwn o ddilysu gyda gofal gan ei fod yn llai diogel na'r dull safonol.

Awdurdodiad: Sylfaenol [base64]
Example:
Awdurdodiad: YWRtaW46YWxnbwo sylfaenol=
Dilysu sylfaenol cynample:

GORCHYMYNAU

 Gorchmynion API RESTful

Isod mae rhestr o'r holl orchmynion API a gefnogir.

Nodyn
Mae cais PUT yn newid neu'n creu adnodd parhaol sy'n goroesi ailgychwyn, tra bod cais POST yn rheoli'r ddyfais ar gyfer y sesiwn gyfredol yn unig.

Disgrifiad	Dull	URI	Llwyth tâl Paramedrau	Dychwelyd Example	Cynnyrch	FW
Adalw gwerth paramedr penodol.	CAELWCH	/api/settings/[key-name] Ex./api/settings/audio.page.vol	Amh	{"audio.page.vol": "-18dB"}	Pawb	>3.3
Dychwelwch y lefel sŵn amgylchynol wedi'i fesur mewn desibelau. Rhaid galluogi Iawndal Sŵn Amgylchynol yn y tab Gosodiadau Sylfaenol -> Nodweddion.	CAELWCH	/api/info/audio.noise.level	Amh	{"audio.noise.level": 72}	Siaradwyr Arddangos Siaradwyr	>3.3
Echdynnu statws y derfynell mewnbwn ras gyfnewid.	CAELWCH	/api/info/input.relay.status	Amh	{"input.relay.status": "segur"} neu {"input.relay.status": "active"}	Pob cynnyrch sydd â mewnbwn cyfnewid, ac eithrio'r 8063. Gweler isod.	>4.1
Echdynnu statws terfynellau Mewnbwn 1 neu Mewnbwn 2.	CAELWCH	/api/info/input.relay1.status neu /api/info/input.relay2.status	Amh	{"input.relay1.status": "segur"} neu {"input.relay1.status": "active"}	8063	>4.1
Adalw'r rhestr o dôn files gosod ar hyn o bryd.	CAELWCH	/api/info/tonelist	Amh	{“tonelist”:[“bell-na.wav”,,”bell uk.wav”,”buzzer.wav”,…]}	Pawb	>5.0
Adalw'r wybodaeth dyfais a ddangosir ar y dudalen Statws.	CAELWCH	/api/info/status	Amh	Rhestr lawn o wybodaeth o'r tab Statws.	Pawb	>5.4

Adalw'r wybodaeth am y cynnyrch a ddangosir ar y dudalen Amdanon ni.	CAELWCH	/api/gwybodaeth/amdano	Amh	Mae'r holl wybodaeth yn bresennol ar y tab About.	Pawb	>5.4
Ysgogi'r strôb gyda pharamedrau lliw a phatrwm dymunol.	SWYDD	/api/controls/strobe/cychwyn	patrwm: {0 – 15} lliw1: {glas, coch, ambr, gwyrdd} lliw2: {glas, coch, ambr, gwyrdd} ledlvl: {1 – 255} dal drosodd: {gwir, ffug}	Amh	8128(G2) 8138 8190S	>3.3
Stopiwch y strôb.	SWYDD	/api/controls/strobe/stop	Amh	Amh	8128(G2) 8138 8190S	>3.3
Chwarae tôn unwaith neu ddolen iddo.	SWYDD	/api/rheolaethau/tôn/cychwyn	llwybr: {tone} ie. clychau.wav dolen: {gwir, ffug} neu {0, 1} ee {"llwybr":"chime.wav", "loop":true}	Amh	Siaradwyr 8301 8373 8028(G2) 8201 8039	>3.3
Stopiwch y tôn.	SWYDD	/api/rheolaethau/tôn/stopio	Amh	Amh	Siaradwyr 8301 8373 8028(G2) 8201 8039	>3.3
Ffoniwch estyniad ffôn gyda neges wedi'i recordio ymlaen llaw.	SWYDD	/api/rheolaethau/galwad/cychwyn	{"estyniad":"2099", “tôn”: “gong.wav”, “cyfwng”:”0″, “maxdur”:”10″}	Amh	Siaradwyr 8301 8410 8420	>3.3
Gorffennwch yr alwad.	SWYDD	/api/rheolaethau/galwad/stopio	Amh	Amh	Siaradwyr 8301 8410 8420	>3.3

Cychwyn galwad tudalen un ffordd. Bydd y ddyfais yn derbyn y ffrwd sain o estyniad targed.	SWYDD	/api/controls/call/tudalen	{"estyniad":" ” }	Amh	Siaradwyr 8410 8420	>5.3.4
Ailgychwyn y pwynt terfyn targed.	SWYDD	/api/rheolaethau/ailgychwyn	Amh	Amh	Pawb	>3.3
Datgloi'r drws. Mae “lleol” yn rheoli'r ras gyfnewid leol mae “netdc1” yn rheoli rheolydd drws y rhwydwaith o bell (8063)	SWYDD	/api/controls/drws/datgloi	doorid: {lleol, netdc1} Dewisol	Amh	8039 8028(G2) 8201 8063	>3.3
Cloi y drws.	SWYDD	/api/rheolaethau/drws/clo	doorid: {lleol, netdc1} Dewisol	Amh	8039 8028(G2) 8201 8063	>3.3
Galluogi'r ras gyfnewid 24v aux out.	SWYDD	ap/controls/24v/galluogi	Amh	Amh	8063	>5.0
Analluoga'r ras gyfnewid 24v aux out.	SWYDD	api/controls/24v/analluogi	Amh	Amh	8063	>5.0
Galluogi'r ras gyfnewid allbwn.	SWYDD	/api/rheolaethau/cyfnewid/galluogi	Amh	Amh	8063	>5.0
Analluoga'r ras gyfnewid allbwn.	SWYDD	/api/rheolaethau/cyfnewid/analluogi	Amh	Amh	8063	>5.0
Gwiriwch weinydd firmware Algo am y fersiwn firmware diweddaraf.	SWYDD	/api/rheolaethau/uwchraddio/gwirio	Amh	{"fersiwn": "diweddaru"} neu {"fersiwn": " ” }	Pawb	>4.1
Gwiriwch weinydd firmware Algo am y fersiwn firmware diweddaraf ac uwchraddiwch i'r fersiwn honno.	SWYDD	/api/rheolaethau/uwchraddio/cychwyn	Amh	{"status": "diweddaru"} neu { “status”: “uwchraddio ”, “url”: url>} neu {"statws": " ” }	Pawb	>4.1
Arddangos delwedd neu batrwm ar y sgrin.	SWYDD	/api/controls/sgrin/cychwyn	Gwel isod	Amh	8410 8420	>5.3.4
Stopiwch y patrwm sgrin a dychwelyd i'r sgrin ddiofyn.	SWYDD	/api/rheolaethau/sgrin/stop	Amh	Amh	8410 8420	>5.3.4

Ailgychwyn y prif gais.	SWYDD	/api/rheolaethau/ail-lwytho	Amh	Amh	Pawb	>5.3.4
Dechreuwch wrando ar ffrwd sain uniongyrchol. Ffurfweddwch y rhif porthladd y mae'r ffrwd yn cael ei anfon ato.	SWYDD	/api/controls/rx/cychwyn	{"porthladd": }	Amh	Pawb	>5.3.4
Rhoi'r gorau i wrando ar ffrwd sain uniongyrchol.	SWYDD	/api/controls/rx/stop	Amh	Amh	Pawb	>5.3.4
Gosodwch y modd aml-ddarlledu.	RHOI	/api/state/mcast/diweddaru/	{"modd": "anfonwr", "cyfeiriad": , "porthladd": , “math”:”rtp”} neu {“modd”: “anfonwr”, “cyfeiriad”: , "porthladd": , “math”:”poly”, “grŵp”:1} **Sylwer**: Os defnyddir rheolyddion / tôn / cychwyn cyn y gorchymyn hwn, bydd y tôn yn chwarae gan ddefnyddio gosodiadau cyfredol ar y web UI.	Amh	8301	>5.0
Mewnosodwch werth i baramedr penodol o lwyth cyflog JSON.	RHOI	/api/gosodiadau	paramedr: {value} ee {"audio.page.vol": "-3dB"}	Amh	8180(G2) 8186 8190 8190S 8301 8373	>3.3

 Gorchmynion Rhyngwyneb Rheoli Syml (SCI).

Mae pob gorchymyn SCI yn geisiadau GET ac mae ganddynt y paramedrau cyffredin “usi” a “admin” ar gyfer dilysu.
Example:
CAEL http:// /sci/controls/door/datgloi?usr=admin&pwd=algo&doorid=lleol

Disgrifiad	URI	Ychwanegol Llwyth tâl Paramedrau	Cynhyrchion	FW
Datgloi'r drws. Mae “lleol” yn rheoli'r ras gyfnewid leol mae “netdc1” yn rheoli rheolydd drws y rhwydwaith o bell (8063)	/sci/controls/gwneud neu/datgloi	doorid: {lleol, netdc1} Dewisol	8039 8028(G2) 8201 8063	>3.3
Cloi y drws.	/sci/rheolaethau/gwneud neu/cloi	doorid: {lleol, netdc1} Dewisol	8039 8028(G2) 8201 8063	>3.3
Chwarae tôn unwaith neu ddolen iddo.	/sci/controls/i ne/cychwyn	llwybr: {tone} ie. clychau.wav dolen: {gwir, ffug} neu {0, 1}	Pawb	>3.3
Stopiwch y tôn.	/sci/rheolaethau/i ne/stopio	Amh	Pawb	>3.3
Ysgogi'r strôb gyda pharamedrau lliw a phatrwm dymunol.	/sci/controls/strobe/dechrau	patrwm: {0 – 15} lliw1: {glas, coch, ambr, gwyrdd} lliw 2: {glas, coch, ambr, gwyrdd} ledlvl: {1 – 255} holdover: {gwir, gau}	8128(G2) 8138 8190S	>3.3
Stopiwch y strôb.	/sci/controls/strobe/stop	Amh	8128(G2) 8138 8190S	>3.3

Dogfennau / Adnoddau

	API RESTful ALGO [pdfCanllaw Defnyddiwr AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	API RESTful ALGO [pdfCanllaw Defnyddiwr AL061-GU-CP000API-230717, API RESTful, RESTful, API

Cyfeiriadau

• Llawlyfr Defnyddiwr