ALGO RESTful API

Tlhahisoleseding ea Sehlahisoa: Tataiso ea RESTful API

Algo RESTful API e lumella basebelisi ho fihlella, ho laola, le ho qala liketso ho Algo IP Endpoints marang-rang a bona ka likopo tsa HTTP/HTTPS. Tokomane ena e fana ka sete e ts'oanang le e hlalositsoeng esale pele ea ts'ebetso e se nang naha e ka sebelisoang ho sebelisana le lisebelisoa tsa Algo. API e tšehetsa likopo tsa HTTP/HTTPS GET, POST, le PUT ka litefiso tsa JSON.

Netefatso

Ho na le mefuta e meraro ea netefatso e fumanehang ka Algo RESTful API:

• Netefatso e tloaelehileng (e lumelletsoe ke kamehla)
• Netefatso ea mantlha (ka boikhethelo)
• Ha ho mokhoa oa netefatso (ha o khothalletsoe; molemong oa liteko feela)

Litaelo tsa Tšebeliso ea Sehlahisoa: RESTful API

Lintho tse hlokahalang

Pele o lumella RESTful API, etsa bonnete ba hore sesebelisoa se na le khokahanyo ea inthanete ho fihlella li-server tsa NTP tse lokiselitsoeng esale pele. Haeba ho se na khokahanyo ea inthanete, lokisa seva ea NTP ea lehae ebe u kenya aterese ea eona ea IP.

E nolofalletsa RESTful API

1. Kena ka sesebelisoa sa web sehokelo ebe u ea ho Advanced Settings Admin tab ya.
2. Tsamaisetsa tlase ho karolo ea Tšehetso ea API 'me u nolofalletse RESTful API.
3. Beha phasewete eo u e batlang (password ea kamehla: algo). Hlokomela hore netefatso e tloaelehileng e nolofalitsoe ke kamehla.

Nobles Basic Authentication (Boikhethelo)

1. Ho web sehokelo, ea ho tab ea Tlhokomelo ea Sistimi 'me u khoasolle tlhophiso file.
2. Bula tlhophiso file ka mohlophisi ofe kapa ofe oa mongolo 'me u kenye mola o latelang: api.auth.basic = 1
3. Boloka le ho kenya tlhophiso e fetotsoeng file khutlela ho sesebelisoa ho sebelisa Khutlisa Configuration File e hlahang ho tab ya Tlhokomelo ya Sistimi.

Ho nolofatsa mokhoa oa ho netefatsa ha ho na bopaki (boikhethelo)

Ho nolofalletsa mokhoa oa ho se netefatse, tlohela karolo ea RESTful API Password e se na letho. Mokhoa ona ha oa khothaletsoa mme o lokela ho sebelisoa feela molemong oa tlhahlobo hobane ha o fane ka tšireletso.

Ho bulela Interface e Bonolo ea Taolo (Ka boikhethelo)

1. Holima web sehokelo, ea ho tab ea Tlhokomelo ea Sistimi 'me u khoasolle tlhophiso file.
2. Bula tlhophiso file ka ho sebelisa mohlophisi oa mongolo ebe o eketsa mela e 'meli. Fetola phasewete eo u e batlang.
3. Admin.web.sci = 1
4. Sci.admin.pwd =
5. Boloka le ho kenya tlhophiso e fetotsoeng file khutlela ho sesebelisoa ho sebelisa Khutlisa Configuration File e hlahang ho tab ya Tlhokomelo ya Sistimi.

Netefatso SampKhoutu

Ka kopo, romella lengolo-tsoibila support@algosolutions.com haeba u ka rata ho netefatsa maemo kapa motheo oa sampkhoutu.
Bakeng sa tšehetso e eketsehileng, letsetsa 604-454-3792 kapa imeile support@algosolutions.com

Litsebiso tsa Boitsebiso

Hlokomela
Tlhokomeliso e bonts'a lintlafatso, lintlha le litaelo tse lokelang ho lateloa

Boithorollo

Boitsebiso bo teng tokomaneng ena ho lumeloa hore bo nepahetse ka litsela tsohle empa ha boa tiisetsoa ke Algo. Boitsebiso bo ka fetoha ntle le tsebiso 'me ha boa lokela ho nkoa ka tsela leha e le efe e le boitlamo ba Algo kapa leha e le efe ea mekhatlo e amanang le eona kapa lithuso. Algo le mekhatlo e ikopantseng le makalana ha ba nke boikarabello bakeng sa liphoso leha e le life kapa lintho tse sieo tokomaneng ena. Litokiso tsa tokomane ena kapa likhatiso tse ncha tsa eona li ka fanoa ho kenyelletsa liphetoho tse joalo. Algo ha e jare boikarabello bakeng sa litšenyehelo kapa litlaleho tse bakoang ke tšebeliso leha e le efe ea bukana ena kapa lihlahisoa tse joalo, software, firmware, le/kapa hardware. Ha ho karolo ea tokomane ena e ka hlahisoang bocha kapa ho fetisoa ka mokhoa ofe kapa ofe kapa ka mokhoa ofe kapa ofe - oa elektroniki kapa oa mochini - molemong ofe kapa ofe ntle le tumello e ngotsoeng e tsoang ho Algo.
Bakeng sa lintlha tse ling kapa thuso ea tekheniki Amerika Leboea, ka kopo ikopanye le sehlopha sa tšehetso sa Algo:

Algo Theknoloji Support
1-604-454-3792
support@algosolutions.com

©2022 Algo ke letshwao la kgwebo le ngodisitsweng la Algo Communication Products Ltd.
Litokelo tsohle li sirelelitsoe. Matshwao a mang kaofela ke thepa ya beng ba ona. Lintlha tsohle li ka fetoha ntle le tsebiso.

 KAKARETSO

Selelekela

Tokomane ena e hlalosa hore na Algo RESTful API e ka sebelisoa joang ho fihlella, ho thetsa, le ho qala liketso ho Algo IP Endpoints ho marang-rang a hau ka likopo tsa HTTP/HTTPS, hammoho le mekhoa e mengata e fapaneng ea netefatso e nang le maemo a fapaneng a ts'ireletso. Ho kopa litsamaiso ho ka sebelisana le lisebelisoa tsa Algo ka junifomo le sete e boletsoeng esale pele ea ts'ebetso e se nang naha e hlalositsoeng tokomaneng ena. Likopo li etsoa ho URI ea mosebelisi ka mojaro oa moputso oa JSON 'me o batla karabo ea JSON. Likopo tsa HTTP/HTTPS GET, POST, le PUT li etsoa ho URI ea lisebelisoa hammoho le mojaro oa moputso oa JSON (sheba karolo ea litaelo bakeng sa lethathamo la litefiso).

 Netefatso

Ho na le mefuta e meraro ea netefatso:

•  E tloaelehileng (e khothaletsoa)
•  Motheo
•  Ha ho letho (ha le khothalletsoe)

Netefatso e Tloaelehileng e sebelisa Hash-based Message Authentication Code (HMAC) e nang le SHA-256 encoded digest. Netefatso ea mantlha e sebelisa khouto ea Base64 mme e lokela ho sebelisoa feela ho feta HTTPS. Ha ho netefatso e lokelang ho sebelisoa feela ka tlhokomelo e feteletseng kaha ha e fane ka netefatso. Sheba karolo ea Litlhoko tsa netefatso bakeng sa lintlha tse ling.

TLHOKOMELISO LE TIISETSO

Lintho tse hlokahalang

•  Tokomane ena e nka hore Algo endpoint e sebelisa firmware version 3.3 kapa ho feta.
•  Phapang ea nako lipakeng tsa mokopi le lisebelisoa tsa Algo e lokela ho ba ka tlase ho metsotsoana e 30 ho sebelisa netefatso e tloaelehileng.
• Netefatsa hore NTP (Network Time Protocol) e ea sebelisoa. Liaterese tsa li-server tsa NTP tse tloaelehileng li ka hlophisoa ho Litlhophiso tse Tsoetseng Pele → Taba ea Nako.

Hlokomela
Li-server tsa NTP tse lokiselitsoeng esale pele li amoheloa ke sechaba, kahoo khokahanyo ea Marang-rang ea hlokahala ho e fihlela. Haeba ho se na khokahanyo ea inthanete, lokisa seva ea NTP ea lehae ebe u kenya aterese ea eona ea IP.

• Netefatsa hore nako ya sesebediswa sa Algo e fetotswe ho ya sebakeng se nepahetseng sa nako. Sena se ka etsoa ka ho ea ho "Advanced Settings" tab ya → Nako.

 E nolofalletsa RESTful API

1. Kena ho web sehokelo ebe u ea ho Litlhophiso tse Tsoetseng Pele → Tabo ea Tsamaiso.
2. Tsamaisetsa tlase ho karolo ea Ts'ehetso ea API, nolofalletsa API ea RESTful 'me u behe Lekunutu kamoo u batlang (lentsoe la kamehla: algo)
   Hlokomela
   Netefatso e tloaelehileng e nolofalitsoe ke kamehla.

Numella Netefatso ea Motheo (Boikhethelo)

1. Ho web sehokelo, ea ho Sisteme → Tlhophiso tab mme o jarolle tlhophiso file.
2. Bula tlhophiso file ka mohlophisi ofe kapa ofe oa mongolo 'me u kenye mola o latelang: api.auth.basic = 1
3.  Boloka le ho kenya tlhophiso e fetotsoeng file khutlela ho sesebelisoa ho sebelisa Khutlisa Configuration File tšobotsi ho Sistimi → Tlhophiso tab.

Ha ho mokhoa oa ho netefatsa (ha ho boikhethelo)

Ho nolofalletsa mokhoa oa ho se netefatse, tlohela karolo ea RESTful API Password e se na letho. Mokhoa ona ha oa khothaletsoa mme o lokela ho sebelisoa feela molemong oa tlhahlobo hobane ha o fane ka tšireletso.

Ho bulela Interface e Bonolo ea Taolo (Ka boikhethelo)

1. Holima web sehokelo, ea ho Sisteme → Tlhophiso tab mme o jarolle tlhophiso file.
2.  Bula tlhophiso file ka ho sebelisa mohlophisi oa mongolo ebe o eketsa mela e 'meli. Fetola the ho password eo u e batlang. Admin.web.sci = 1
   Sci.admin.pwd =
3.  Boloka le ho kenya tlhophiso e fetotsoeng file khutlela ho sesebelisoa ho sebelisa Khutlisa Configuration File tšobotsi ho Sistimi → Tlhophiso tab.

TIISETSO LIHLOKO

Ka kopo, romella lengolo-tsoibila support@algosolutions.com haeba u ka rata ho netefatsa maemo kapa motheo oa sampkhoutu.

Kopo e Tloaelehileng ea Netefatso ka JSON Payload

Lihlooho tse hlokahalang kopong ea HTTP/HTTPS
> Mofuta oa Likahare: "application/json"
> Content-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Tumello: hmac admin:[nonce]:[hmac_output]
Lihlooho tsa tumello li na le:

1. Mohala oa 'hmac admin' o lateloa ke colon ':'.
2. Nonce - Boleng bo sa reroang kapa bo sa iphetang, bo lateloang ke colon ':'.
3. Hmac_output - e hlahisoa ke RESTful API Password (senotlolo sa lekunutu) se hlophisitsoeng sesebelisoa sa hau le tlhahiso ea HMAC, joalo ka ha ho le ka tlase:
   [kopo_mokgwa]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[ha ho mohla]

Ho kenya HMAC mohlalaample: (sebelisa 'algo' joalo ka senotlolo sa lekunutu)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Hlahisa HMAC ka password le khoele ea ho kenya HMAC ha u ntse u cheka ka SHA-256:
HMAC tlhahiso example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Letsatsi: letsatsi, khoeli ea letsatsi, selemo hr:min:sec GMT
Example
Letsatsi: Labone, 22 Sept, 2022 02:33:07 GMT
Netefatso e tloaelehileng e nang le mojaro oa moputso exampLe:

 Kopo e Tloaelehileng ea Bopaki ntle le JSON Payload

E ts'oana le 3.1 ka lihlooho tse amanang le litaba/hmac e siiloe.
Kenyelletso ea HMAC: [request_method]:[request_uri]:[timestamp]:[ha ho mohla] HMAC input example: (sebelisa 'algo' joalo ka senotlolo sa lekunutu)
FUMANA:/api/settings/audio.page.vol:1601312252:49936
Hlahisa HMAC ka password le khoele ea ho kenya ea HMAC u sebelisa SHA-256:
HMAC tlhahiso example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Netefatso e tloaelehileng ntle le mojaro oa moputso exampLe:

 Kopo ea Netefatso ea Motheo

Mokhoa ona oa ho netefatsa o lokela ho sebelisoa ka hloko kaha ha o sireletsehe ho feta mokhoa o tloaelehileng.

Tumello: Motheo [base64]
ExampLe:
Tumello: Motheo YWRtaW46YWxnbwo=
Netefatso ea mantlha exampLe:

TAELO

 RESTful API Litaelo

Ka tlase ke lethathamo la litaelo tsohle tse tšehetsoeng tsa API.

Hlokomela
Kopo ea PUT e fetoha kapa e theha sesebelisoa sa ka ho sa feleng se pholohang ha se qala, ha kopo ea POST e laola sesebelisoa bakeng sa seboka sa hajoale.

Tlhaloso	Mokhoa	URI	Ho lefa Mekhahlelo	Kgutla Example	Sehlahisoa	FW
Khutlisa boleng ba paramente e itseng.	FUMANA	/api/settings/[key-name] Ex./api/settings/audio.page.vol	N/A	{“audio.page.vol”: “-18dB”}	Tsohle	> 3.3
Khutlisetsa boemo ba lerata bo lekantsoeng ka li-decibel. Matšeliso a Lerata a Ambient a tlameha ho lumelloa ho Litlhophiso tsa Motheo -> Thebo ea likarolo.	FUMANA	/api/info/audio.noise.level	N/A	{“audio.noise.level”: 72}	Libui li Bontša Libui	> 3.3
Hlakola boemo ba sebaka sa ho kenya li-relay.	FUMANA	/api/info/input.relay.status	N/A	{“input.relay.status”: “idle”} kapa {“input.relay.status”: “active”}	Lihlahisoa tsohle tse nang le ho kenya letsoho, ntle le 8063. Sheba ka tlase.	> 4.1
Ntša boemo ba Input 1 kapa Input 2 terminals.	FUMANA	/api/info/input.relay1.status kapa /api/info/input.relay2.status	N/A	{“input.relay1.status”: “idle”} kapa {“input.relay1.status”: “active”}	8063	> 4.1
Khutlisa lenane la molumo filee kentsoe hajoale.	FUMANA	/api/info/tonelist	N/A	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	Tsohle	> 5.0
Fumana lintlha tsa sesebelisoa tse hlahang leqepheng la Boemo.	FUMANA	/api/info/status	N/A	Lenane le felletseng la tlhahisoleseding ho tswa ho tab ya Boemo.	Tsohle	> 5.4

Fumana lintlha tsa sehlahisoa tse hlahang leqepheng la Mabapi.	FUMANA	/api/info/mabapi	N/A	Lintlha tsohle tse teng tabeng ea About.	Tsohle	> 5.4
Kenya tšebetsong strobe ka mebala e lakatsehang le liparamente tsa paterone.	PHOSO	/api/controls/strobe/start	mohlala: {0 - 15} color1: {buluu, bokhubelu, amber, botala} mmala2: {buluu, bokhubelu, amber, botala} ledlvl: {1 – 255} ho ts'oara: {'nete, leshano}	N/A	8128(G2) 8138 8190S	> 3.3
Emisa strobe.	PHOSO	/api/controls/strobe/stop	N/A	N/A	8128(G2) 8138 8190S	> 3.3
Bapala molumo hang kapa u e lokise.	PHOSO	/api/controls/tone/start	tsela: {tone} ke hore. chime.wav loop: {nete, bohata} kapa {0, 1} mohlala {“path”:”chime.wav”, “loop”:true}	N/A	Libui 8301 8373 8028(G2) 8201 8039	> 3.3
Emisa molumo.	PHOSO	/api/controls/tone/stop	N/A	N/A	Libui 8301 8373 8028(G2) 8201 8039	> 3.3
Letsetsa katoloso ea mohala ka molaetsa o rekotiloeng esale pele.	PHOSO	/api/controls/call/start	{"katoloso":"2099", “tone”:”gong.wav”, “nako”:”0″, “maxdur”:”10″}	N/A	Libui 8301 8410 8420	> 3.3
Qetella mohala.	PHOSO	/api/controls/call/stop	N/A	N/A	Libui 8301 8410 8420	> 3.3

Qala mohala o eang feela leqepheng. Sesebelisoa se tla fumana molumo oa molumo ho tsoa ho katoloso ea sepheo.	PHOSO	/api/controls/call/page	{“katoloso”:” ”}	N/A	Libui 8410 8420	> 5.3.4
Qala bocha ntlha ea ho qetela.	PHOSO	/api/controls/reboot	N/A	N/A	Tsohle	> 3.3
Notlolla lemati. "local" e laola "netdc1" ea "relay" ea lehae e laola molaoli oa monyako oa marang-rang (8063)	PHOSO	/api/controls/door/unlock	monyako: {local, netdc1} * Boikhethelo	N/A	8039 8028(G2) 8201 8063	> 3.3
Notlela lemati.	PHOSO	/api/controls/door/lock	monyako: {local, netdc1} * Boikhethelo	N/A	8039 8028(G2) 8201 8063	> 3.3
Numella 24v aux out relay.	PHOSO	api/controls/24v/enable	N/A	N/A	8063	> 5.0
Tlosa 24v aux out relay.	PHOSO	api/controls/24v/disable	N/A	N/A	8063	> 5.0
Lumella phepelo ea tlhahiso.	PHOSO	/api/controls/relay/enable	N/A	N/A	8063	> 5.0
Tlosa phepelo ea tlhahiso.	PHOSO	/api/controls/relay/disable	N/A	N/A	8063	> 5.0
Sheba sesebelisoa sa firmware sa Algo bakeng sa mofuta oa morao-rao oa firmware.	PHOSO	/api/controls/upgrade/check	N/A	{“version”: “updated”} kapa {“phetolelo”: “ ”}	Tsohle	> 4.1
Lekola seva ea firmware ea Algo bakeng sa mofuta oa morao-rao oa firmware 'me u ntlafatse ho mofuta oo.	PHOSO	/api/controls/upgrade/start	N/A	{“boemo”: “e nchafalitsoe”} kapa {“boemo”: “ntlafatso ","url”: url>} kapa {“boemo”: “ ”}	Tsohle	> 4.1
Hlahisa setšoantšo kapa paterone skrineng.	PHOSO	/api/controls/screen/start	Bona ka tlase	N/A	8410 8420	> 5.3.4
Emisa mohlala oa skrine ebe u khutlela skrineng sa kamehla.	PHOSO	/api/controls/screen/stop	N/A	N/A	8410 8420	> 5.3.4

Qala hape ts'ebeliso ea mantlha.	PHOSO	/api/controls/reload	N/A	N/A	Tsohle	> 5.3.4
Qala ho mamela molumo o tobileng. Lokisa nomoro ea boema-kepe moo molaetsa o romelloang teng.	PHOSO	/api/controls/rx/start	{“kou”: }	N/A	Tsohle	> 5.3.4
Khaotsa ho mamela molumo o tobileng.	PHOSO	/api/controls/rx/stop	N/A	N/A	Tsohle	> 5.3.4
Seta mokhoa oa multicast.	LEBETSA	/api/state/mcast/update/	{“mode”:”mothomeli”, “aterese”: , "kou": , "type":"rtp"} kapa {"mode":"sender", "aterese": , "kou": , "mofuta":"poly", "sehlopha":1} **Tlhokomeliso**: Haeba ho sebelisoa li-control/tone/start pele ho taelo ena, molumo o tla bapala o sebelisa li-setting tsa hajoale ho web UI.	N/A	8301	> 5.0
Kenya boleng ho paramethara e itseng ho tsoa ho JSON payload.	LEBETSA	/api/settings	paramethara: {value} mohlala {“audio.page.vol”: “-3dB”}	N/A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Litaelo tse bonolo tsa Sehokelo sa Taolo (SCI).

Litaelo tsohle tsa SCI ke likopo tsa GET mme li na le liparamente tse tloaelehileng "usi" le "admin" bakeng sa netefatso.
ExampLe:
FUMANA http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Tlhaloso	URI	Tlatsetso Ho lefa Mekhahlelo	Lihlahisoa	FW
Notlolla lemati. "local" e laola "netdc1" ea "relay" ea lehae e laola molaoli oa monyako oa marang-rang (8063)	/sci/controls/do or/unlock	monyako: {local, netdc1} * Boikhethelo	8039 8028(G2) 8201 8063	> 3.3
Notlela lemati.	/sci/controls/do or/lock	monyako: {local, netdc1} * Boikhethelo	8039 8028(G2) 8201 8063	> 3.3
Bapala molumo hang kapa u e lokise.	/sci/controls/to ne/start	tsela: {tone} ke hore. chime.wav loop: {nete, bohata} kapa {0, 1}	Tsohle	> 3.3
Emisa molumo.	/sci/controls/to ne/stop	N/A	Tsohle	> 3.3
Kenya tšebetsong strobe ka mebala e lakatsehang le liparamente tsa paterone.	/sci/controls/strobe/start	mohlala: {0 – 15} color1: {putsoa, ​​khubelu, amber, tala} color2: {buluu, khubelu, amber, tala} ledlvl: {1 - 255} ho ts'oara: {nnete, leshano}	8128(G2) 8138 8190S	> 3.3
Emisa strobe.	/sci/controls/strobe/stop	N/A	8128(G2) 8138 8190S	> 3.3

Litokomane / Lisebelisoa

	ALGO RESTful API [pdf] Bukana ea Mosebelisi AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful API [pdf] Bukana ea Mosebelisi AL061-GU-CP000API-230717, RESTful API, RESTful, API

Litšupiso

• Bukana ea Mosebelisi