ọdịnaya zoo
1 ALGO RESTful API
2 Ozi ngwaahịa: Ntuziaka API RESTful
3 Nyocha
4 Ntuziaka ojiji ngwaahịa: API RESTful
4.1 Ihe achọrọ
4.2 Na-akwado API RESTful
4.3 Na-eme ka nyocha isi (Nhọrọ)
4.4 Na-eme ka enweghị usoro nyocha (nhọrọ)
4.5 Na-eme ka interface njikwa dị mfe (Nhọrọ)
5 Nyocha Sampna Koodu
6 Ozi Ozi
7 Nkwuputa
8 Izugbe
8.1 Okwu mmalite
8.2 Nyocha
9 Nhazi na nhazi
9.1 Ihe achọrọ
9.2 Na-akwado API RESTful
9.3 Kwado nkwenye bụ isi (nhọrọ)
9.4 Enweghị usoro nyocha (nhọrọ)
9.5 Na-eme ka interface njikwa dị mfe (Nhọrọ)
10 NKWUKWU RỊRỊRỊRỊ
10.1 Arịrịọ Nyocha Ọkọlọtọ na nkwụ ụgwọ JSON
10.2 Arịrịọ nyocha ọkọlọtọ na-enweghị ibu JSON
10.3 Arịrịọ nkwenye bụ isi
11 IWU
11.1 Iwu API RESTful
11.2 Iwu njikwa dị mfe (SCI).
12 Akwụkwọ / akụrụngwa
12.1 Ntụaka

Akara ALGO RESTful API

ALGO RESTful API

Ngwaahịa ALGO RESTful API

Ozi ngwaahịa: Ntuziaka API RESTful

Algo RESTful API na-enye ndị ọrụ ohere ịnweta, megharịa, na ịkpalite omume na Algo IP Endpoints na netwọk ha site na arịrịọ HTTP/HTTPS. Akwụkwọ a na-enye otu nhazi na kọwapụta nke arụrụ ọrụ enweghị obodo nke enwere ike iji mekọrịta ngwaọrụ Algo. API na-akwado HTTP/HTTPS GET, POST, na PUT na-akwụ ụgwọ JSON.

Nyocha

Enwere ụdị nkwenye atọ dị na Algo RESTful API:

  • Nyocha ọkọlọtọ (nke ndabara kwadoro)
  • Nyocha ntọala (nhọrọ)
  • Enweghị usoro nyocha (anaghị akwado ya; naanị maka ebumnuche nnwale)

Ntuziaka ojiji ngwaahịa: API RESTful

Ihe achọrọ

Tupu ịmee API RESTful, hụ na ngwaọrụ ahụ nwere njikọ ịntanetị iji ruo sava NTP ahaziburu. Ọ bụrụ na enweghị njikọ ịntanetị dị, hazie sava NTP mpaghara wee tinye adreesị IP ya.

Na-akwado API RESTful
  1. Banye n'ime ngwaọrụ ahụ web interface wee gaa na taabụ Admin Ntọala dị elu.
  2. Pịgharịa gaa na ngalaba Nkwado API wee mee API RESTful.
  3. Tọọ paswọọdụ achọrọ (okwuntughe ndabara: algo). Mara na agbanyere nyocha ọkọlọtọ site na ndabara.
Na-eme ka nyocha isi (Nhọrọ)
  1. N'ime web interface, gaa na taabụ Mmezi Sistemu wee budata nhazi ahụ file.
  2. Mepee nhazi ahụ file ya na onye ndezi ederede ọ bụla wee tinye ahịrị a: api.auth.basic = 1
  3. Chekwaa ma bulite nhazi a gbanwere file laghachi na ngwaọrụ site na iji weghachi nhazi File atụmatụ dị na taabụ Mmezi Sistemu.
Na-eme ka enweghị usoro nyocha (nhọrọ)

Iji mee ka usoro enweghị nyocha, hapụ mpaghara Paswọdu API RESTful efu. A naghị atụ aro usoro a ma ekwesịrị iji ya naanị maka ebumnuche nnwale naanị ebe ọ na-enye enweghị nchekwa.

Na-eme ka interface njikwa dị mfe (Nhọrọ)
  1. Na web interface, gaa na taabụ Mmezi Sistemu wee budata nhazi ahụ file.
  2. Mepee nhazi ahụ file iji editọ ederede wee tinye ahịrị abụọ. Gbanwee paswọọdụ n'ọchịchọ gị.
  3. Admin.web.sci = 1
  4. Sci.admin.pwd =
  5. Chekwaa ma bulite nhazi a gbanwere file laghachi na ngwaọrụ site na iji weghachi nhazi File atụmatụ dị na taabụ Mmezi Sistemu.

Nyocha Sampna Koodu

Biko email support@algosolutions.com ọ bụrụ na-amasị gị ọkọlọtọ ma ọ bụ isi nkwenye sample koodu.
Maka nkwado ọzọ, kpọọ 604-454-3792 ma ọ bụ email support@algosolutions.com

Ozi Ozi

Rịba ama
Rịba ama na-egosi mmelite bara uru, ozi na ntuziaka kwesịrị ịgbaso

Nkwuputa

Ekwenyere na ozi dị n'ime akwụkwọ a ziri ezi n'ụzọ niile mana Algo akwadoghị ya. Ozi a ga-agbanwe agbanwe na-enweghị ọkwa na e kwesịghị ịkọwa ya n'ụzọ ọ bụla dị ka nkwa nke Algo ma ọ bụ ndị mmekọ ma ọ bụ ndị enyemaka ya. Algo na ndị mmekọ ya na ndị enyemaka anaghị anara ọrụ ọ bụla maka mperi ma ọ bụ mwepu ọ bụla na akwụkwọ a. Enwere ike ịnye ngbanwe nke akwụkwọ a ma ọ bụ mbipụta ọhụrụ ya iji tinye mgbanwe ndị a. Algo anaghị ewere ụgwọ ọ bụla maka mmebi ma ọ bụ nkwuputa sitere na iji akwụkwọ ntuziaka a ma ọ bụ ngwaahịa, ngwanro, firmware na/ma ọ bụ ngwaike. Enweghị akụkụ nke akwụkwọ a nwere ike ịmegharị ma ọ bụ bufee ya n'ụdị ọ bụla ma ọ bụ n'ụzọ ọ bụla - eletrọnịkị ma ọ bụ igwe - maka ebumnuche ọ bụla na-enweghị ikike ederede site na Algo.
Maka ozi ndị ọzọ ma ọ bụ enyemaka aka aka na North America, biko kpọtụrụ ndị otu nkwado Algo:

Nkwado nka na ụzụ Algo
1-604-454-3792
support@algosolutions.com

©2022 Algo bụ ụghalaahịa edenyere n'akwụkwọ ikikere nke Algo Communication Products Ltd.
Ikike niile echekwabara. Ighalaahịa ndị ọzọ niile bụ ihe onwunwe nke ndị nwe ha. Nkọwa niile nwere ike ịgbanwe na-enweghị ọkwa.

 Izugbe

Okwu mmalite

Akwụkwọ a na-akọwa ka enwere ike iji Algo RESTful API nweta, megharịa, na kpalite omume na Algo IP Endpoints na netwọk gị site na arịrịọ HTTP/HTTPS yana ụzọ nyocha dị iche iche nwere ọkwa nchekwa dị iche iche. Sistemu na-arịọ nwere ike iji ngwaọrụ Algo na-emekọrịta ihe site na otu ụdị arụrụ ọrụ enweghị obodo akọwara n'ime akwụkwọ a. A na-arịọ arịrịọ na URI akụrụngwa nwere ibu JSON wee nweta nzaghachi JSON. A na-arịọ arịrịọ HTTP/HTTPS GET, POST, na PUT iji nweta uru URI yana ụgwọ ọrụ JSON (lee ngalaba iwu maka ndepụta nke ibu akwụ ụgwọ).

 Nyocha

Enwere ụdị nkwenye atọ:

  •  Ọkọlọtọ (atụ aro)
  •  Isi
  •  Ọ nweghị (anaghị atụ aro)

Nyocha ọkọlọtọ na-eji koodu nyocha ozi dabere na Hash (HMAC) nwere mgbari SHA-256 etinyere. Nyocha ndabere na-eji ntinye Base64 ma ekwesịrị iji ya mee ihe karịa HTTPS. Enweghị nkwenye ekwesịrị iji naanị na oke nlezianya mee ihe n'ihi na ọ naghị enye nkwenye. Hụ ngalaba chọrọ nyocha maka nkọwa ndị ọzọ.

Nhazi na nhazi

Ihe achọrọ
  •  Akwụkwọ a na-eche na njedebe Algo na-agba ụdị firmware 3.3 ma ọ bụ karịa.
  •  Ọdịiche oge dị n'etiti onye na-arịọ arịrịọ na ngwaọrụ Algo kwesịrị ịbụ ihe na-erughị 30 sekọnd iji jiri nyocha ọkọlọtọ.
  • Gbaa mbọ hụ na eji NTP (Network Time Protocol) na-arụ ọrụ. Enwere ike ịhazi adreesị nke sava NTP omenala na Ntọala di elu → Oge taabụ.

Rịba ama
A na-anabata sava NTP ndị a haziri nke ọma, yabụ a chọrọ njikọ ịntanetị iji ruo ya. Ọ bụrụ na enweghị njikọ ịntanetị dị, hazie sava NTP mpaghara wee tinye adreesị IP ya.

  • Gbaa mbọ hụ na agbanweela oge ngwaọrụ Algo ka ọ bụrụ mpaghara oge ziri ezi. Enwere ike ime nke a site na ịgagharị na taabụ Advanced Settings → Time tab.
 Na-akwado API RESTful
  1. Banye n'ime web interface wee gaa na Ntọala di elu → Admin tab.
  2. Pịgharịa gaa na ngalaba Nkwado API, mee ka API RESTful wee tọọ Okwuntughe ka achọrọ (okwuntughe ndabara: algo)
    Rịba ama
    Agbanyere nyocha ọkọlọtọ site na ndabara.ALGO RESTful API 01
Kwado nkwenye bụ isi (nhọrọ)
  1. N'ime web interface, gaa na Sistemu → Mmezi taabụ wee budata nhazi ahụ file.
  2. Mepee nhazi ahụ file ya na onye ndezi ederede ọ bụla wee tinye ahịrị a: api.auth.basic = 1
  3.  Chekwaa ma bulite nhazi a gbanwere file laghachi na ngwaọrụ site na iji weghachi nhazi File atụmatụ na Sistemu → Mmezi taabụ.
Enweghị usoro nyocha (nhọrọ)

Iji mee ka usoro enweghị nyocha, hapụ mpaghara Paswọdu API RESTful efu. A naghị atụ aro usoro a ma ekwesịrị iji ya naanị maka ebumnuche nnwale naanị ebe ọ na-enye enweghị nchekwa.

Na-eme ka interface njikwa dị mfe (Nhọrọ)
  1. Na web interface, gaa na Sistemu → Mmezi taabụ wee budata nhazi ahụ file.
  2.  Mepee nhazi ahụ file iji editọ ederede wee tinye ahịrị abụọ. Gbanwee na paswọọdụ gị chọrọ. Admin.web.sci = 1
    Sci.admin.pwd =
  3.  Chekwaa ma bulite nhazi a gbanwere file laghachi na ngwaọrụ site na iji weghachi nhazi File atụmatụ na Sistemu → Mmezi taabụ.

NKWUKWU RỊRỊRỊRỊ

Biko email support@algosolutions.com ọ bụrụ na-amasị gị ọkọlọtọ ma ọ bụ isi nkwenye sample koodu.

Arịrịọ Nyocha Ọkọlọtọ na nkwụ ụgwọ JSON

Ndị nkụnye eji isi mee achọrọ na arịrịọ HTTP/HTTPS
> Ụdị ọdịnaya: "ngwa/json"
> Ọdịnaya-MD5: [content_md5] Ọpụample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Ikike: hmac admin:[nonce]:[hmac_output]
Ndị nkụnye eji isi mee ikike nwere:

  1. eriri 'hmac admin' na-esote colon':'.
  2. Nonce – Uru efu ma ọ bụ anaghị emegharị ya, nke eriri ':' na-esote ya.
  3. Hmac_output – nke RESTful API Paswọdu (igodo nzuzo) ahaziri na ngwaọrụ gị yana ntinye HMAC, dị ka n'okpuru:
    [usoro arịrịọ]:[request_uri]:[content_md5]:[content_type]:[oge kachaamp]:[otu oge]

Ntinye HMAC example: (iji 'algo' dị ka igodo nzuzo)
POST:/api/controls/tone/malite:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Mepụta HMAC na paswọọdụ na eriri ntinye HMAC ka mgbari site na iji SHA-256:
Mmepụta HMA example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Ụbọchị: ụbọchị, ọnwa ụbọchị, afọ hr:min: sec GMT
Example
Ụbọchị: Tọzdee, Septemba 22, 2022 02:33:07 GMT
Nyocha ọkọlọtọ na ụgwọ ọrụ exampLe:

ALGO RESTful API 02

 Arịrịọ nyocha ọkọlọtọ na-enweghị ibu JSON

Yiri 3.1 nwere nkụnye eji isi mee/ihe ntinye hmac nwere metụtara ọdịnaya ewepụrụ.
Ntinye HMAC: [request_method]:[request_uri]: [ogeamp]: [otu oge] ntinye HMAC example: (iji 'algo' dị ka igodo nzuzo)
Nweta:/api/settings/audio.page.vol:1601312252:49936
Mepụta HMAC na okwuntughe yana eriri ntinye HMAC site na iji SHA-256:
Mmepụta HMA example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Nyocha ọkọlọtọ na-enweghị ụgwọ ọrụ exampLe:

ALGO RESTful API 03

 Arịrịọ nkwenye bụ isi

Ekwesịrị iji nlezianya jiri usoro nkwenye a mee ihe n'ihi na ọ dịghị nchebe karịa usoro ọkọlọtọ.

Ikike: Basic [base64]
ExampLe:
Ikike: Isi YWRtaW46YWxnbwo=
Nyocha ndabere exampLe:
ALGO RESTful API 04

IWU

 Iwu API RESTful

N'okpuru bụ ndepụta nke iwu API niile akwadoro.

Rịba ama
Arịrịọ PUT na-agbanwe ma ọ bụ mepụta akụrụngwa na-adịgide adịgide na-adịgide ndụ nrụgharị, ebe arịrịọ POST na-ejikwa naanị ngwaọrụ maka nnọkọ dị ugbu a.

Nkọwa Usoro URI Ibu ibu Oke laghachi Example Ngwaahịa FW
Weghachite uru nke otu oke.  Nweta /api/settings/[isi-aha] Ex./api/settings/audio.page.vol  N/A  {"audio.page.vol": "-18dB"}  Ha niile  > 3.3
Weghachite ọkwa mkpọtụ gburugburu tụrụ na decibels. A ga-agbanyerịrị nkwụghachi ụzụ mkpọtụ na ntọala ntọala -> taabụ atụmatụ. Nweta /api/info/audio.noise.level N/A {"audio.noise.level": 72}  Ndị na-ekwu okwu na-egosipụta ndị ọkà okwu > 3.3
 Wepụ ọkwa nke ọdụ ntinye ọsọ ọsọ. Nweta /api/info/input.relay.status N/A  

{"input.relay.status": "arụ ọrụ"} ma ọ bụ {"input.relay.status": "na-arụ ọrụ"}

 Ngwaahịa niile nwere ntinye ọsọ ọsọ, ewezuga 8063. Lee n'okpuru. > 4.1
 Wepụ ọkwa nke ntinye 1 ma ọ bụ ntinye 2.  Nweta /api/info/input.relay1.status ma ọ bụ /api/info/input.relay2.status  N/A {"input.relay1.status": "abaghị uru"} ma ọ bụ {"input.relay1.status": "na-arụ ọrụ"}  8063  > 4.1
Weghachite ndepụta ụda filearụnyere ugbu a.  Nweta  /api/info/tonelist  

N/A

 {“tonelist”:[“bell-na.wav”,”mgb uk.wav”,”buzzer.wav”,…]}  Ha niile  > 5.0
Weghachite ozi ngwaọrụ egosiri na ibe ọnọdụ.  Nweta  /api/info/status  N/A  Ndepụta ozi zuru oke sitere na taabụ Ọnọdụ.  Ha niile  > 5.4
Weghachite ozi ngwaahịa egosiri na ibe Ihe.  Nweta /api/info/gbasara  N/A  Ozi niile dị na About tab. Ha niile > 5.4
Mee ka strobe rụọ ọrụ site na iji ụcha na ụkpụrụ achọrọ. Biputere /api/controls/strobe/mbido ụkpụrụ: {0-15}
agba1: {acha anụnụ anụnụ, uhie, amber, akwụkwọ ndụ akwụkwọ ndụ} color2: {acha anụnụ anụnụ, uhie, amber, akwụkwọ ndụ akwụkwọ ndụ} ledlvl: {1-255}
njide: {ezi, ụgha}		 N/A  8128(G2)
8138
8190S		 > 3.3
 Kwụsị strobe.  Biputere  /api/controls/strobe/stop  N/A  N/A 8128(G2)
8138
8190S		 > 3.3
Kpọọ ụda otu ugboro ma ọ bụ kpachie ya. Biputere /api/controls/tone/bido uzo: {tone} ya bu. chime.wav
loop: {ezi, ụgha} ma ọ bụ {0, 1}
dịka {“ụzọ”:”chime.wav”, “loop”:true}		 N/A Ndị na-ekwu okwu 8301
8373
8028(G2)
8201
8039		 > 3.3
Kwụsị ụda. Biputere /api/controls/tone/stop N/A N/A Ndị na-ekwu okwu 8301
8373
8028(G2)
8201
8039		 > 3.3
Kpọọ ndọtị ekwentị nwere ozi edekọburu. Biputere /api/controls/ call/bido  {"mgbatị":"2099",
"ụda":"gong.wav", "n'etiti":"0", "maxdur":"10″}		 N/A Ndị na-ekwu okwu 8301
8410
8420		 > 3.3
Kwụsị oku. Biputere /api/controls/call/stop N/A N/A Ndị na-ekwu okwu 8301
8410
8420		 > 3.3
Bido oku ibe otu ụzọ. The ngwaọrụ ga-enweta audio iyi si lekwasịrị ndọtị.  Biputere  /api/controls/call/page  {"extension":" ”}  N/A Ndị na-ekwu okwu 8410
8420		  > 5.3.4
Magharịa ebe njedebe ebumnuche. Biputere /api/controls/reboot N/A N/A Ha niile > 3.3
Mepee ụzọ. "Local" na-achịkwa relay mpaghara "netdc1" na-achịkwa ọnụ ụzọ netwọk dịpụrụ adịpụ (8063) Biputere /api/controls/door/unlock ọnụ ụzọ: {mpaghara, netdc1}
*Nhọrọ		 N/A 8039
8028(G2)
8201
8063		 > 3.3
Kpuchie ụzọ. Biputere /api/controls/door/lock  ọnụ ụzọ: {mpaghara, netdc1}
*Nhọrọ		 N/A 8039
8028(G2)
8201
8063		 > 3.3
Kwado 24v aux out relay. Biputere api/controls/24v/ nwee ike N/A N/A 8063 > 5.0
Gbanyụọ relay 24v aux out. Biputere api/controls/24v/gbanyụọ N/A N/A 8063 > 5.0
Kwado mgbanaka mmepụta. Biputere /api/controls/relay/enable N/A N/A 8063 > 5.0
Gbanyụọ mgbasa ozi. Biputere /api/controls/relay/gbanyụọ N/A N/A 8063 > 5.0
Lelee ihe nkesa firmware Algo maka ụdị firmware kachasị ọhụrụ.  Biputere  /api/controls/upgrade/ check  N/A {"ụdị":" emelitere"} ma ọ bụ
{"ụdị":" ”}		  Ha niile  > 4.1
 Lelee ihe nkesa firmware Algo maka ụdị firmware kachasị ọhụrụ wee kwalite na ụdị ahụ. Biputere /api/controls/upgrade/bido N/A {"ọnọdụ": "emelitere"} ma ọ bụ
{"ọnọdụ": "kwalite ","url": url>} ma ọ bụ
{"ọnọdụ": " ”}		 Ha niile > 4.1
Gosipụta onyonyo ma ọ bụ ụkpụrụ na ihuenyo.  Biputere  /api/controls/screen/bido  Lee n'okpuru  N/A 8410
8420		  > 5.3.4
Kwụsị ụkpụrụ ihuenyo wee laghachi na ihuenyo ndabara.  Biputere  /api/controls/screen/stop  N/A  N/A 8410
8420		  > 5.3.4
Malitegharịa ngwa ngwa. Biputere /api/controls/bugharia N/A N/A Ha niile > 5.3.4
Malite ige ntị na iyi ọdịyo ozugbo. Hazie nọmba ọdụ ụgbọ mmiri a na-ezigara iyi ahụ. Biputere /api/controls/rx/start {"ọdụ ụgbọ mmiri": } N/A Ha niile   > 5.3.4
Kwụsị ige ntị na iyi ọdịyo ozugbo. Biputere  /api/controls/rx/stop  N/A  N/A  Ha niile  > 5.3.4
Tọọ ụkpụrụ multicast. Tinye /api/state/mcast/update/ {"ụkpụrụ":"nzipu", "adreesị": , "ọdụ ụgbọ mmiri": , "ụdị":"rtp"} ma ọ bụ {"mode":"zitere", "adreesị": , "ọdụ ụgbọ mmiri": , "ụdị":"poly", "otu":1}
** Rụba ama ***: Ọ bụrụ na ejiri njikwa / ụda / mmalite tupu iwu a, ụda ga-egwu site na iji ntọala dị ugbu a na web UI.		 N/A 8301 > 5.0
Fanye uru na otu oke site na nkwụ ụgwọ JSON. Tinye /api/nhazi oke: {uru}
eg {"audio.page.vol": "-3dB"}		 N/A 8180(G2)
8186
8190
8190S
8301
8373		 > 3.3
 Iwu njikwa dị mfe (SCI).

Iwu SCI niile bụ arịrịọ GET ma nwee parampat nkịtị "usi" na "admin" maka nyocha.
ExampLe:
Nweta http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid= local

 Nkọwa  URI Mgbakwunye Ibu ibu Oke Ngwaahịa  FW
Mepee ụzọ.
"Local" na-achịkwa relay mpaghara "netdc1" na-achịkwa ọnụ ụzọ netwọk dịpụrụ adịpụ (8063)		 /sci/controls/me ma ọ bụ/kpọghee ọnụ ụzọ: {mpaghara, netdc1}
*Nhọrọ		 8039
8028(G2)
8201
8063		 > 3.3
Kpuchie ụzọ. /sci/controls/eme ma ọ bụ/mkpọchi ọnụ ụzọ: {mpaghara, netdc1}
*Nhọrọ		 8039
8028(G2)
8201
8063		 > 3.3
Kpọọ ụda otu ugboro ma ọ bụ kpachie ya.  /sci/controls/to ne/bido uzo: {tone} ya bu. chime.wav
loop: {ezi, ụgha} ma ọ bụ {0, 1}		 Ha niile  > 3.3
Kwụsị ụda. /sci/controls/to ne/stop  N/A  Ha niile  > 3.3
Mee ka strobe rụọ ọrụ site na iji ụcha na ụkpụrụ achọrọ. /sci/controls/strobe/bido ụkpụrụ: {0 - 15} agba1: {acha anụnụ anụnụ, uhie, amber, akwụkwọ ndụ akwụkwọ ndụ}
agba2: {acha anụnụ anụnụ, ọbara ọbara, amber, green}
ledlvl: {1 - 255} njide: {ezi, ụgha}		 8128(G2)
8138
8190S		 > 3.3
 Kwụsị strobe.  /sci/controls/strobe/stop  N/A 8128(G2)
8138
8190S		  > 3.3

Akwụkwọ / akụrụngwa

ALGO RESTful API [pdf] Ntuziaka onye ọrụ
AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, API RESTful, RESTful, API
ALGO RESTful API [pdf] Ntuziaka onye ọrụ
AL061-GU-CP000API-230717, API RESTful, RESTful, API

Ntụaka

Hapụ ikwu

Agaghị ebipụta adreesị ozi-e gị. Akara mpaghara achọrọ akara *