ALGO RESTful API

Fiosrachadh Bathar: RESTful API Guide

Tha an Algo RESTful API a’ leigeil le luchd-cleachdaidh faighinn a-steach, a làimhseachadh, agus gnìomhan a bhrosnachadh air Algo IP Endpoints air an lìonra aca tro iarrtasan HTTP/HTTPS. Tha an sgrìobhainn seo a’ toirt seachad seata èideadh agus ro-mhìnichte de ghnìomhachd gun stàite a ghabhas cleachdadh gus eadar-obrachadh le innealan Algo. Tha an API a’ toirt taic do HTTP/HTTPS GET, POST, agus iarrtasan PUT le luchdan pàighidh JSON.

Dearbhadh

Tha trì seòrsaichean dearbhaidh rim faighinn leis an Algo RESTful API:

• Dearbhadh àbhaisteach (air a chomasachadh gu bunaiteach)
• Dearbhadh bunaiteach (roghainneil)
• Gun dòigh dearbhaidh (chan eil e air a mholadh; dìreach airson adhbharan deuchainn)

Stiùireadh Cleachdadh Bathar: RESTful API

Ro-ghoireasan

Mus cuir thu an comas API RESTful, dèan cinnteach gu bheil ceangal eadar-lìn aig an inneal gus na frithealaichean NTP ro-shuidhichte a ruighinn. Mura h-eil ceangal eadar-lìn ri fhaighinn, cuir air dòigh frithealaiche NTP ionadail agus cuir a-steach an seòladh IP aige.

A’ comasachadh an RESTful API

1. Log a-steach don inneal web eadar-aghaidh agus seòladh chun tab Admin Settings Advanced.
2. Scrollaich sìos chun roinn Taic API agus leig leis an API RESTful.
3. Suidhich am facal-faire a tha thu ag iarraidh (facal-faire bunaiteach: algo). Thoir an aire gu bheil dearbhadh àbhaisteach air a chomasachadh gu bunaiteach.

A’ comasachadh Dearbhadh Bunasach (Roghainneil)

1. Anns a web eadar-aghaidh, seòladh gu taba cumail suas an t-siostaim agus luchdaich sìos an rèiteachadh file.
2. Fosgail an rèiteachadh file le deasaiche teacsa sam bith agus cuir ris an loidhne a leanas: api.auth.basic = 1
3. Sàbhail agus luchdaich suas an rèiteachadh atharraichte file air ais chun inneal a’ cleachdadh an Restore Configuration File feart ann an taba cumail suas an t-siostaim.

A’ comasachadh gun dòigh dearbhaidh (roghainneil)

Gus an dòigh gun dearbhadh a chomasachadh, fàg an raon RESTful API Password falamh. Chan eilear a’ moladh an dòigh seo agus cha bu chòir a chleachdadh ach airson adhbharan deuchainn a-mhàin leis nach eil e a’ toirt seachad tèarainteachd.

A’ comasachadh eadar-aghaidh smachd sìmplidh (roghainneil)

1. Air an web eadar-aghaidh, seòladh gu taba cumail suas an t-siostaim agus luchdaich sìos an rèiteachadh file.
2. Fosgail an rèiteachadh file a’ cleachdadh deasaiche teacsa agus cuir dà loidhne ris. Atharraich am facal-faire gu do mhiann.
3. Rianachd.web.sci = 1
4. Sci.admin.pwd =
5. Sàbhail agus luchdaich suas an rèiteachadh atharraichte file air ais chun inneal a’ cleachdadh an Restore Configuration File feart ann an taba cumail suas an t-siostaim.

Dearbhadh Sample Còd

Feuch an cuir thu post-d taic@algosolutions.com ma tha thu ag iarraidh dearbhadh àbhaisteach no bunaiteach sampan còd.
Airson taic a bharrachd, cuir fòn gu 604-454-3792 no post-d taic@algosolutions.com

Brathan Fiosrachaidh

Thoir an aire
Tha nota a’ nochdadh ùrachaidhean feumail, fiosrachadh, agus stiùireadh a bu chòir a leantainn

Àicheadh

Thathas a’ creidsinn gu bheil am fiosrachadh anns an sgrìobhainn seo ceart anns a h-uile dòigh ach chan eil e airidh air le Algo. Faodaidh am fiosrachadh atharrachadh gun rabhadh agus cha bu chòir a mhìneachadh ann an dòigh sam bith mar ghealladh le Algo no gin de na cleamhnaichean no na fo-chompanaidhean aige. Chan eil Algo agus a chompanaich agus a fo-chompanaidhean a’ gabhail uallach sam bith airson mearachdan no dearmad sam bith san sgrìobhainn seo. Faodar ath-sgrùdaidhean den sgrìobhainn seo no deasachaidhean ùra dheth a chuir a-mach gus na h-atharrachaidhean sin a thoirt a-steach. Chan eil Algo a’ gabhail uallach sam bith airson milleadh no tagraidhean a thig bho bhith a’ cleachdadh an leabhar-làimhe seo no a leithid de thoraidhean, bathar-bog, firmware, agus/no bathar-cruaidh. Chan urrainnear pàirt sam bith den sgrìobhainn seo ath-riochdachadh no a ghluasad ann an cruth sam bith no ann an dòigh sam bith - dealanach no meacanaigeach - airson adhbhar sam bith gun chead sgrìobhte bho Algo.
Airson fiosrachadh a bharrachd no taic theicnigeach ann an Ameireaga a Tuath, cuir fios gu sgioba taic Algo:

Taic Teicnigeach Algo
1-604-454-3792
taic@algosolutions.com

©2022 Tha Algo na chomharra-malairt clàraichte de Algo Communication Products Ltd.
Gach còir glèidhte. Is ann leis an luchd-seilbh aca a tha a h-uile comharra-malairt eile. Faodaidh na specs uile atharrachadh gun rabhadh.

 COITCHEANN

Ro-ràdh

Tha an sgrìobhainn seo a’ mìneachadh mar as urrainnear Algo RESTful API a chleachdadh gus faighinn gu, làimhseachadh, agus gnìomhan air Algo IP Endpoints air an lìonra agad tro iarrtasan HTTP/HTTPS, a bharrachd air dà dhòigh dearbhaidh eadar-dhealaichte le diofar ìrean de thèarainteachd. Faodaidh siostaman tagraidh eadar-obrachadh le innealan Algo tro sheata de ghnìomhachd gun stàit èideadh agus ro-mhìnichte a tha air a mhìneachadh san sgrìobhainn seo. Bithear a’ cur iarrtasan gu URI goireas le uallach pàighidh JSON agus a’ faighinn freagairt JSON. Thathas a’ dèanamh iarrtasan HTTP/HTTPS GET, POST, agus PUT gus URI a ghoireas còmhla ri uallach pàighidh JSON (faic an roinn òrdughan airson liosta de luchdan pàighidh).

 Dearbhadh

Tha trì seòrsaichean dearbhaidh ann:

•  Coitcheann (air a mholadh)
•  Bunaiteach
•  Chan eil gin (chan eil e air a mholadh)

Bidh an dearbhadh àbhaisteach a’ cleachdadh Còd Dearbhaidh Teachdaireachd stèidhichte air Hash (HMAC) le geàrr-chunntas air a chòdachadh le SHA-256. Bidh dearbhadh bunaiteach a’ cleachdadh còdachadh Base64 agus cha bu chòir a chleachdadh ach thairis air HTTPS. Cha bu chòir dearbhadh sam bith a chleachdadh ach le fìor chùram oir chan eil e a’ toirt seachad dearbhadh. Faic an roinn Riatanasan Dearbhaidh airson tuilleadh fiosrachaidh.

SETUP AND CONFIGUATION

Ro-ghoireasan

•  Tha an sgrìobhainn seo a’ gabhail ris gu bheil crìoch Algo a’ ruith dreach firmware 3.3 no nas àirde.
•  Bu chòir an eadar-dhealachadh ùine eadar an neach-iarrtais agus na h-innealan Algo a bhith nas lugha na 30 diog airson dearbhadh àbhaisteach a chleachdadh.
• Dèan cinnteach gu bheilear a’ cleachdadh NTP (Network Time Protocol). Faodar seòlaidhean frithealaichean àbhaisteach NTP a rèiteachadh anns an taba Roghainnean adhartach → Ùine.

Thoir an aire
Tha na frithealaichean NTP ro-shuidhichte air an cumail gu poblach, mar sin tha feum air ceangal eadar-lìn gus a ruighinn. Mura h-eil ceangal eadar-lìn ri fhaighinn, cuir air dòigh frithealaiche NTP ionadail agus cuir a-steach an seòladh IP aige.

• Dèan cinnteach gu bheil ùine siostam inneal Algo air atharrachadh chun raon ùine cheart. Faodar seo a dhèanamh le bhith a’ seòladh chun taba Roghainnean adhartach → Ùine.

 A’ comasachadh an RESTful API

1. Log a-steach don web eadar-aghaidh agus seòladh chun taba Roghainnean adhartach → Rianachd.
2. Scrollaich sìos chun roinn Taic API, leig leis an API RESTful agus suidhich am Facal-faire mar a thogras tu (facal-faire bunaiteach: algo)
   Thoir an aire
   Tha dearbhadh àbhaisteach air a chomasachadh gu bunaiteach.

Dèan comas air Dearbhadh Bunasach (Roghainneil)

1. Anns a web eadar-aghaidh, rach chun t-Siostam → tab cumail suas agus luchdaich sìos an rèiteachadh file.
2. Fosgail an rèiteachadh file le deasaiche teacsa sam bith agus cuir ris an loidhne a leanas: api.auth.basic = 1
3.  Sàbhail agus luchdaich suas an rèiteachadh atharraichte file air ais chun inneal a’ cleachdadh an Restore Configuration File feart anns an tab System → Maintenance.

Gun dòigh dearbhaidh (roghainneil)

Gus an dòigh gun dearbhadh a chomasachadh, fàg an raon RESTful API Password falamh. Chan eilear a’ moladh an dòigh seo agus cha bu chòir a chleachdadh ach airson adhbharan deuchainn a-mhàin leis nach eil e a’ toirt seachad tèarainteachd.

A’ comasachadh eadar-aghaidh smachd sìmplidh (roghainneil)

1. Air an web eadar-aghaidh, rach chun t-Siostam → tab cumail suas agus luchdaich sìos an rèiteachadh file.
2.  Fosgail an rèiteachadh file a’ cleachdadh deasaiche teacsa agus cuir dà loidhne ris. Atharraich an ri d’ fhacal-faire miann. Rianachd.web.sci = 1
   Sci.admin.pwd =
3.  Sàbhail agus luchdaich suas an rèiteachadh atharraichte file air ais chun inneal a’ cleachdadh an Restore Configuration File feart anns an tab System → Maintenance.

RIAGHAILTEAN A' GHAIDHEALACH

Feuch an cuir thu post-d taic@algosolutions.com ma tha thu ag iarraidh dearbhadh àbhaisteach no bunaiteach sampan còd.

Iarrtas Dearbhaidh Coitcheann le uallach pàighidh JSON

Cinn-cinn riatanach ann an iarrtas HTTP / HTTPS
> Seòrsa susbaint: “tagradh / json”
> Susbaint-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Ùghdarrachadh: hmac admin:[nonce]:[hmac_output]
Tha cinn-cinn an ùghdarrais air a dhèanamh suas de:

1. Tha an sreang 'hmac admin' air a leantainn le coloin ':'.
2. Nonce - Luach air thuaiream no nach eil ag ath-aithris, air a leantainn le coloin ':'.
3. Hmac_output - air a chruthachadh le Facal-faire RESTful API (iuchrach dìomhair) air a rèiteachadh air an inneal agad agus cuir a-steach HMAC, mar gu h-ìosal:
   [request_method]: [request_uri]: [content_md5]: [content_type]: [uair as àirdeamp]:[neo]

Cuir a-steach HMAC example: (a' cleachdadh 'algo' mar an iuchair dhìomhair)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Cruthaich HMAC le facal-faire agus sreang cuir a-steach HMAC mar chnàmh a’ cleachdadh SHA-256:
Toradh HMAC example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Ceann-latha: latha, mìos ceann-latha, bliadhna hr: min: diog GMT
Example
Ceann-latha: Diardaoin, 22 Sultain, 2022 02:33:07 GMT
Dearbhadh àbhaisteach le payload example:

 Iarrtas Dearbhaidh Coitcheann Às aonais uallach pàighidh JSON

Co-ionann ri 3.1 le cinn-cinn co-cheangailte ri susbaint / cuir a-steach hmac air fhàgail air falbh.
Cuir a-steach HMAC: [request_method]: [request_uri]: [timestamp]:[neo] Cuir a-steach HMAC example: (a' cleachdadh 'algo' mar an iuchair dhìomhair)
FAIGH:/api/settings/audio.page.vol:1601312252:49936
Cruthaich HMAC le facal-faire agus sreang cuir a-steach HMAC a’ cleachdadh SHA-256:
Toradh HMAC example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Dearbhadh àbhaisteach gun luchd-pàighidh example:

 Iarrtas dearbhaidh bunaiteach

Bu chòir an dòigh dearbhaidh seo a chleachdadh gu faiceallach leis nach eil e cho tèarainte ris an dòigh àbhaisteach.

Ùghdarrachadh: Bunasach [base64]
Example:
Ùghdarrachadh: Basic YWRtaW46YWxnbwo=
Dearbhadh bunaiteach example:

COMHRADH

 Òrdughan RESTful API

Gu h-ìosal tha liosta de na h-òrdughan API le taic.

Thoir an aire
Bidh iarrtas PUT ag atharrachadh no a’ cruthachadh goireas maireannach a mhaireas ath-thòiseachadh, fhad ‘s nach bi iarrtas POST a’ cumail smachd ach air an inneal airson an t-seisein làithreach.

Tuairisgeul	Dòigh-obrach	URI	Pàighidh Paramadairean	Tilleadh Example	Bathar	FW
Faigh luach paramadair sònraichte.	FAIGHINN	/api/settings/[key-name] Ex./api/settings/audio.page.vol	Chan eil	{"audio.page.vol": "-18dB"}	Uile	> 3.3
Thoir air ais an ìre fuaim àrainneachd air a thomhas ann an decibels. Feumaidh dìoladh fuaim àrainneachd a bhith air a chomasachadh ann an roghainnean bunaiteach - tab> Feartan.	FAIGHINN	/api/info/audio.noise.level	Chan eil	{"audio.noise.level": 72}	Bidh luchd-labhairt a’ taisbeanadh luchd-labhairt	> 3.3
Thoir a-mach inbhe ceann-uidhe cuir a-steach an t-sealaidheachd.	FAIGHINN	/api/info/input.relay.status	Chan eil	{"input.relay.status": "idle"} no {"input.relay.status": "gnìomhach"}	A h-uile toradh le cuir a-steach sealaidheachd, ach a-mhàin an 8063. Faic gu h-ìosal.	> 4.1
Thoir a-mach inbhe cinn-uidhe Input 1 no Input 2.	FAIGHINN	/api/info/input.relay1.status no /api/info/input.relay2.status	Chan eil	{"input.relay1.status": "idle"} no {"input.relay1.status": "gnìomhach"}	8063	> 4.1
Luchdaich a-nuas an clàr tone files air a stàladh an-dràsta.	FAIGHINN	/api/info/tonelist	Chan eil	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	Uile	> 5.0
Faigh air ais am fiosrachadh inneal a tha air a thaisbeanadh air duilleag Inbhe.	FAIGHINN	/api/info/inbhe	Chan eil	Liosta slàn fiosrachaidh bhon tab Inbhe.	Uile	> 5.4

Faigh am fiosrachadh toraidh a tha air a thaisbeanadh air an duilleag Mu dheidhinn.	FAIGHINN	/api/fiosrachadh/mu dheidhinn	Chan eil	A h-uile fiosrachadh a tha an làthair air an tab About.	Uile	> 5.4
Cuir an gnìomh an strobe leis na crìochan dath is pàtrain a tha thu ag iarraidh.	POST	/api/controls/strobe/tòiseachadh	pàtran: {0 – 15} dath 1: {gorm, dearg, ubair, uaine} color2: {gorm, dearg, ubair, uaine} ledlvl: {1 - 255} grèim: {fìor, ceàrr}	Chan eil	8128(G2) 8138 8190S	> 3.3
Cuir stad air an strobe.	POST	/api/smachd/strobe/stad	Chan eil	Chan eil	8128(G2) 8138 8190S	> 3.3
Cluich tòn uair no lùb e.	POST	/api/smachd/tòna/tòiseachadh	frith-rathad: {tone} ie. chime.wav lùb: {fìor, ceàrr} neo {0, 1} me {“path”:”chime.wav”, “loop”: true}	Chan eil	Luchd-labhairt 8301 8373 8028(G2) 8201 8039	> 3.3
Cuir stad air an tòn.	POST	/api/smachd/tòna/stad	Chan eil	Chan eil	Luchd-labhairt 8301 8373 8028(G2) 8201 8039	> 3.3
Cuir fòn gu leudachadh fòn le teachdaireachd ro-chlàraichte.	POST	/api/smachd/gairm/tòiseachadh	{"leudachadh":" 2099", “tòn”: ”gong.wav”, “interval”:” 0 ″, “maxdur”: ”10″}	Chan eil	Luchd-labhairt 8301 8410 8420	> 3.3
Cuir crìoch air a’ ghairm.	POST	/api/smachd/gairm/stad	Chan eil	Chan eil	Luchd-labhairt 8301 8410 8420	> 3.3

Tòisich gairm duilleag aon-shligheach. Gheibh an inneal an sruth claisneachd bhon leudachadh targaid.	POST	/api/controls/call/page	{"leudachadh":" ”}	Chan eil	Luchd-labhairt 8410 8420	> 5.3.4
Ath-thòisich am puing crìochnachaidh targaid.	POST	/api/controls/ath-thòiseachadh	Chan eil	Chan eil	Uile	> 3.3
Fuasgail an doras. Bidh “ionadail” a’ cumail smachd air an t-sealaidheachd ionadail “netdc1” a’ cumail smachd air rianadair doras lìonra iomallach (8063)	POST	/api/controls/doras/fuasgladh	doorid: {ionadail, netdc1} * Roghainneil	Chan eil	8039 8028(G2) 8201 8063	> 3.3
Glasadh an doras.	POST	/api/smachd/doras/glas	doorid: {ionadail, netdc1} * Roghainneil	Chan eil	8039 8028(G2) 8201 8063	> 3.3
Dèan comas air an t-sealaidheachd 24v aux a-mach.	POST	api/controls/24v/comas	Chan eil	Chan eil	8063	> 5.0
Cuir dheth an t-sealaidheachd 24v aux out.	POST	api / smachdan / 24v / cuir à comas	Chan eil	Chan eil	8063	> 5.0
Dèan comas air an t-sealaidheachd toraidh.	POST	/api/controls/relay/comas	Chan eil	Chan eil	8063	> 5.0
Cuir dheth an t-sealaidheachd toraidh.	POST	/api/controls/relay/disable	Chan eil	Chan eil	8063	> 5.0
Thoir sùil air frithealaiche firmware Algo airson an tionndadh as ùire de firmware.	POST	/api/smachd/ùrachadh/seic	Chan eil	{"dreach": "ùrachadh"} no {"dreach": " ”}	Uile	> 4.1
Thoir sùil air frithealaiche firmware Algo airson an tionndadh firmware as ùire agus àrdaich chun dreach sin.	POST	/api/smachd/àrdachadh/tòiseachadh	Chan eil	{"inbhe": "ùrachadh"} no {"inbhe": "ag ùrachadh ”, “url”: url>} no {"inbhe": " ”}	Uile	> 4.1
Seall dealbh no pàtran air an sgrion.	POST	/api/smachd/sgrion/tòiseachadh	Faic gu h-ìosal	Chan eil	8410 8420	> 5.3.4
Stad am pàtran sgrion agus till air ais chun sgrion bunaiteach.	POST	/api/smachd/sgrion/stad	Chan eil	Chan eil	8410 8420	> 5.3.4

Ath-thòisich am prìomh iarrtas.	POST	/api/smachd/ath-luchdaich	Chan eil	Chan eil	Uile	> 5.3.4
Tòisich ag èisteachd ri sruth claisneachd dìreach. Dèan rèiteachadh air àireamh a' phuirt dhan tèid an t-sruth a chur.	POST	/api/controls/rx/tòiseachadh	{"port": }	Chan eil	Uile	> 5.3.4
Stad ag èisteachd ri sruth claisneachd dìreach.	POST	/api/controls/rx/stad	Chan eil	Chan eil	Uile	> 5.3.4
Suidhich am modh multicast.	PUT	/api/state/mcast/ùrachadh/	{“modh”: “seoladair”, “seòladh”: , “port”: , “seòrsa”: ”rtp”} no {“modh”: “seoladair”, “seòladh”: , “port”: , “seòrsa”: ”poly”, “buidheann”: 1} ** Nòta **: Ma thèid smachdan / tòna / tòiseachadh a chleachdadh ron àithne seo, cluichidh an tòn a’ cleachdadh na roghainnean gnàthach air an web UI.	Chan eil	8301	> 5.0
Cuir a-steach luach gu paramadair sònraichte bho uallach pàighidh JSON.	PUT	/api/roghainnean	paramadair: {luach} me {“audio.page.vol”: “-3dB”}	Chan eil	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Òrdughan eadar-aghaidh smachd sìmplidh (SCI).

Tha a h-uile òrdugh SCI mar iarrtasan GET agus tha na crìochan cumanta “usi” agus “admin” airson dearbhadh.
Example:
FAIGH http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=ionadail

Tuairisgeul	URI	A bharrachd Pàighidh Paramadairean	Bathar	FW
Fuasgail an doras. Bidh “ionadail” a’ cumail smachd air an t-sealaidheachd ionadail “netdc1” a’ cumail smachd air rianadair doras lìonra iomallach (8063)	/ sci / smachdan / dèan no / fhuasgladh	doorid: {ionadail, netdc1} * Roghainneil	8039 8028(G2) 8201 8063	> 3.3
Glasadh an doras.	/sci/smachd/dèan no/glasadh	doorid: {ionadail, netdc1} * Roghainneil	8039 8028(G2) 8201 8063	> 3.3
Cluich tòn uair no lùb e.	/sci/controls/gu neo/tòiseachadh	frith-rathad: {tone} ie. chime.wav lùb: {fìor, ceàrr} neo {0, 1}	Uile	> 3.3
Cuir stad air an tòn.	/sci/controls/gu neo/stad	Chan eil	Uile	> 3.3
Cuir an gnìomh an strobe leis na crìochan dath is pàtrain a tha thu ag iarraidh.	/sci/controls/strobe/tòiseachadh	pàtran: {0 - 15} dath 1: {gorm, dearg, òmar, uaine} dath2: {gorm, dearg, òmar, uaine} ledlvl: {1 - 255} holdover: {fìor, ceàrr}	8128(G2) 8138 8190S	> 3.3
Cuir stad air an strobe.	/sci/smachd/strobe/stad	Chan eil	8128(G2) 8138 8190S	> 3.3

Sgrìobhainnean/Goireasan

	ALGO RESTful API [pdfStiùireadh Cleachdaiche AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful API [pdfStiùireadh Cleachdaiche AL061-GU-CP000API-230717, RESTful API, RESTful, API

Iomraidhean

• Leabhar-làimhe cleachdaiche