ALGO RESTful API

Nga korero mo te hua: RESTful API Aratohu

Ko te Algo RESTful API ka taea e nga kaiwhakamahi te uru atu, te raweke, me te whakaoho i nga mahi i runga i nga Algo IP Endpoints i runga i to raatau whatunga ma nga tono HTTP/HTTPS. Ko tenei tuhinga e whakarato ana i te huinga taurite me te tautuhi-a-mua o nga mahi kore whenua ka taea te whakamahi ki te mahi tahi me nga taputapu Algo. Ka tautokohia e te API nga tono HTTP/HTTPS GET, POST, me PUT me nga utu utu JSON.

Motuhēhēnga

E toru nga momo motuhēhēnga e wātea ana me te Algo RESTful API:

• Motuhēhēnga paerewa (whakahohea taunoa)
• Motuhēhēnga taketake (kōwhiringa)
• Karekau he tikanga motuhēhēnga (kaore i te tūtohutia; mo nga kaupapa whakamatautau anake)

Nga Tohutohu Whakamahi Hua: RESTful API

Nga whakaritenga

I mua i te whakaahei i te RESTful API, me whakarite he hononga ipurangi to te taputapu kia tae atu ki nga tūmau NTP kua whirihorahia. Mena karekau he hononga ipurangi e waatea ana, whirihorahia he tūmau NTP o te rohe ka uru ki tana wāhitau IP.

Whakahohe i te RESTful API

1. Takiuru ki te taputapu web atanga me te whakatere ki te ripa Kaiwhakahaere Tautuhinga Arā Atu Anō.
2. Panuku ki raro ki te waahanga Tautoko API ka whakahohe i te RESTful API.
3. Tautuhia te kupuhipa e hiahiatia ana (kupuhipa taunoa: algo). Kia mahara ko te motuhēhēnga paerewa ka taea te taunoa.

Whakahohe Motuhēhēnga Taketake (Kōwhiringa)

1. I roto i te web atanga, whakatere ki te ripa Tiaki Pūnaha ka tango i te whirihoranga file.
2. Whakatuwherahia te whirihoranga file me tetahi ētita tuhinga me te taapiri i te rarangi e whai ake nei: api.auth.basic = 1
3. Tiakina me te tuku ake i te whirihoranga kua whakarereketia file hoki ki te taputapu ma te whakamahi i te Whakaora Whirihoranga File āhuatanga i te ripa Tiaki Pūnaha.

Whakahohe Kore Tikanga Motuhēhēnga (Kōwhiringa)

Hei whakahohe i te aratuka kore motuhēhēnga, waiho te āpure Kupuhipa RESTful API kia kau. Ko tenei tikanga kaore i te tūtohutia, me whakamahi noa mo nga kaupapa whakamatautau na te mea kaore he haumarutanga.

Whakahohe Atanga Mana Maama (Kōwhiringa)

1. I runga i te web atanga, whakatere ki te ripa Tiaki Pūnaha ka tango i te whirihoranga file.
2. Whakatuwherahia te whirihoranga file te whakamahi i te ētita kuputuhi me te taapiri i nga raina e rua. Hurihia te kupuhipa ki to hiahia.
3. Kaiwhakahaere.web.sci = 1
4. Sci.admin.pwd =
5. Tiakina me te tuku ake i te whirihoranga kua whakarereketia file hoki ki te taputapu ma te whakamahi i te Whakaora Whirihoranga File āhuatanga i te ripa Tiaki Pūnaha.

Motuhēhēnga Sample Waehere

Tena koa imeera support@algosolutions.com ki te hiahia koe ki te motuhēhēnga paerewa, taketake sample waehere.
Mo etahi atu tautoko, waea mai 604-454-3792 īmēra rānei support@algosolutions.com

Panui Korero

Tuhipoka
Ko te tuhipoka e whakaatu ana i nga whakahoutanga whaihua, nga korero, me nga tohutohu me whai

Whakakahoretanga

Ko nga korero kei roto i tenei tuhinga e whakaponohia ana he tika i nga waahanga katoa engari kaore i whakamanahia e Algo. Ko nga korero ka huri noa me te kore panui me te kore e kii i tetahi huarahi hei whakapumautanga na Algo, tetahi o ona hoa, apiti ranei. Karekau he kawenga a Algo me ona hoa me ana apiti mo nga hapa me nga hapa o tenei tuhinga. Ko nga whakahounga o tenei tuhinga, o nga putanga hou ranei ka tukuna hei whakauru i aua huringa. Karekau he kawenga a Algo mo nga pakaru, mo nga kereme ranei i puta mai i te whakamahinga o tenei pukapuka, i aua hua, rorohiko, firmware, me te taputapu. Karekau he wahanga o tenei tuhinga ka taea te whakaputa, te tuku ranei i roto i tetahi ahua, i tetahi huarahi ranei - hiko, miihini ranei - mo tetahi take kaore he whakaaetanga a Algo.
Mo etahi atu korero, awhina hangarau ranei i Amerika Te Tai Tokerau, whakapaa atu ki te roopu tautoko a Algo:

Tautoko Hangarau Algo
1-604-454-3792
support@algosolutions.com

©2022 Ko Algo he tohu rehita o Algo Communication Products Ltd.
Katoa nga Motika. Ko etahi atu tohu hokohoko katoa na o ratou ake rangatira. Ko nga tohu katoa ka whakarereke me te kore panui.

 WHAKANUI

Kupu Whakataki

Ko tenei tuhinga e whakaatu ana me pehea te whakamahi i te Algo RESTful API ki te uru, ki te raweke, ki te whakaoho i nga mahi i runga i nga Algo IP Endpoints i runga i to whatunga na roto i nga tono HTTP/HTTPS, tae atu ki etahi momo momo momo tikanga motuhēhēnga me nga taumata haumarutanga rereke. Ka taea e nga punaha tono te pahekoheko me nga taputapu Algo na roto i te huinga o nga mahi kore whenua kua tautuhia i mua i te tautuhi i roto i tenei tuhinga. Ka tukuna nga tono ki te URI o tetahi rauemi me te utu JSON ka puta he whakautu JSON. Ko nga tono HTTP/HTTPS GET, POST, me PUT ki te rauemi URI me te utu JSON (tirohia te waahanga whakahau mo te rarangi o nga utu utu).

 Motuhēhēnga

E toru nga momo motuhēhēnga:

•  Paerewa (e taunakitia ana)
•  Taketake
•  Kore (kaore i te tūtohu)

Ko te motuhēhēnga Paerewa e whakamahi ana i te Waehere Motuhēhēnga Karere-Hash-based (HMAC) me te keri whakawaehere SHA-256. Ko te motuhēhēnga taketake e whakamahi ana i te whakawaehere Base64 me whakamahi noa i runga HTTPS. Karekau he motuhēhēnga me whakamahi ma te tino tupato i te mea karekau he motuhēhēnga. Tirohia te waahanga Whakaritenga Motuhēhēnga mo etahi atu taipitopito.

WHAKATAHI ME TE WHAKARANGA

Nga whakaritenga

•  Kei te whakaaro tenei tuhinga kei te whakahaeretia e te pito mutunga Algo te putanga firmware 3.3 teitei ake ranei.
•  Ko te rereketanga o te wa i waenga i te kaitono me nga taputapu Algo me iti iho i te 30 hēkona hei whakamahi motuhēhēnga paerewa.
• Me mohio kei te whakamahia a NTP (Kawa Waanga Whatunga). Ka taea te whirihora i nga wahitau o nga tūmau NTP ritenga ki te Tautuhinga Arā Atu Anō → Ripa Wā.

Tuhipoka
Ko nga tūmau NTP kua whirihorahia i mua i te wa e whakahaerehia ana e te iwi katoa, na reira me whai hononga ipurangi ki te toro atu. Mena karekau he hononga ipurangi e waatea ana, whirihorahia he tūmau NTP o te rohe ka uru ki tana wāhitau IP.

• Me whakarite kua whakatikahia te wa o te punaha taputapu Algo ki te rohe wa tika. Ka taea tenei ma te whakatere ki te Tautuhinga Arā Atu Anō → Ripa Wā.

 Whakahohe i te RESTful API

1. Takiuru ki roto i te web atanga me te whakatere ki te Tautuhinga Arā Atu Anō → ripa Kaiwhakahaere.
2. Panuku ki raro ki te waahanga Tautoko API, whakaahei i te RESTful API ka tautuhi i te Kupuhipa ki te hiahia (kupuhipa taunoa: algo)
   Tuhipoka
   Ko te motuhēhēnga paerewa ka taea te taunoa.

Whakahohe Motuhēhēnga Taketake (Kōwhiringa)

1. I roto i te web atanga, whakatere ki te ripa Pūnaha → Tiaki me te tango i te whirihoranga file.
2. Whakatuwherahia te whirihoranga file me tetahi ētita tuhinga me te taapiri i te rarangi e whai ake nei: api.auth.basic = 1
3.  Tiakina me te tuku ake i te whirihoranga kua whakarereketia file hoki ki te taputapu ma te whakamahi i te Whakaora Whirihoranga File āhuatanga i te Pūnaha → ripa Tiaki.

Kore Tikanga Motuhēhēnga (Kōwhiringa)

Hei whakahohe i te aratuka kore motuhēhēnga, waiho te āpure Kupuhipa RESTful API kia kau. Ko tenei tikanga kaore i te tūtohutia, me whakamahi noa mo nga kaupapa whakamatautau na te mea kaore he haumarutanga.

Whakahohe Atanga Mana Maama (Kōwhiringa)

1. I runga i te web atanga, whakatere ki te ripa Pūnaha → Tiaki me te tango i te whirihoranga file.
2.  Whakatuwherahia te whirihoranga file te whakamahi i te ētita kuputuhi me te taapiri i nga raina e rua. Hurihia te ki to kupuhipa hiahia. Kaiwhakahaere.web.sci = 1
   Sci.admin.pwd =
3.  Tiakina me te tuku ake i te whirihoranga kua whakarereketia file hoki ki te taputapu ma te whakamahi i te Whakaora Whirihoranga File āhuatanga i te Pūnaha → ripa Tiaki.

NGA WHAKATAUTANGA

Tena koa imeera support@algosolutions.com ki te hiahia koe ki te motuhēhēnga paerewa, taketake sample waehere.

Tono Motuhēhētanga Paerewa me te Utu Utu JSON

Nga pane e hiahiatia ana i roto i te tono HTTP/HTTPS
> Momo-Ihirangi: "tono/json"
> Ihirangi-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Whakaaetanga: hmac admin:[kotahi]:[hmac_output]
Ko nga pane whakamanatanga ko:

1. Ko te aho 'hmac admin' ka whai i te kopirua ':'.
2. Nonce – He uara matapōkere, kore-tukurua ranei, ka whai i te kopirua ':'.
3. Hmac_output – i hangaia e te Kupuhipa RESTful API (matua-matua) i whirihorahia ki to taputapu me te whakaurunga HMAC, penei i raro nei:
   [tikanga_tono]:[tono_uri]:[ihirangi_md5]:[momo_ihirangi]:[waamp]:[kore]

HMAC tāuru example: (whakamahi 'algo' hei kī ngaro)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Hangaia te HMAC me te kupuhipa me te aho whakauru HMAC hei keri ma te whakamahi SHA-256:
HMAC putanga example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Rā: rā, rā marama, tau hr:min:sec GMT
Example
Rā: Taite, 22 o Hepetema, 2022 02:33:07 GMT
Motuhēhēnga paerewa me te utu utu example:

 Tono Motuhēhētanga Paerewa Karekau he Utu JSON

He rite ki te 3.1 me nga pane e pa ana ki te ihirangi / whakauru hmac i waiho.
Tāuru HMAC: [tikanga_tono]:[tono_uri]:[wāamp]:[kotahi] whakaurunga HMAC example: (whakamahi 'algo' hei kī ngaro)
TIKI:/api/settings/audio.page.vol:1601312252:49936
Hangaia te HMAC me te kupuhipa me te aho whakauru HMAC ma te whakamahi SHA-256:
HMAC putanga example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Motuhēhēnga paerewa kore utu example:

 Tono Motuhēhēnga Taketake

Ko tenei tikanga motuhēhēnga me āta whakamahi i te mea he iti ake te haumaru i te tikanga paerewa.

Whakamana: Taketake [base64]
Example:
Whakamanatanga: Basic YWRtaW46YWxnbwo=
Motuhēhēnga taketake example:

WHAKAMAHI

 Nga Whakahau API

Kei raro nei te rarangi o nga whakahau API tautoko katoa.

Tuhipoka
Ko te tono PUT ka huri, ka waihanga rauemi pumau ranei ka ora i te whakaara ano, engari ma te tono POST anake e whakahaere te taputapu mo te waahi o naianei.

Whakaahuatanga	Tikanga	URI	Utauta Tawhā	Hoki mai Example	Hua	FW
Tikina te uara o tetahi tawhā motuhake.	HAERE	/api/settings/[ingoa-matua] Ex./api/settings/audio.page.vol	N/A	{“audio.page.vol”: “-18dB”}	Katoa	> 3.3
Whakahokia te taumata haruru a tawhio noa i ine ki te decibel. Me whakahohea te Utu Haruru Ambient i roto i nga Tautuhinga Taketake -> Ripa Ahuatanga.	HAERE	/api/info/audio.noise.level	N/A	{“audio.noise.level”: 72}	Kaikōrero Whakaatu Kaikōrero	> 3.3
Tangohia te mana o te tauranga whakauru relay.	HAERE	/api/info/input.relay.status	N/A	{“input.relay.status”: “idle”} or {“input.relay.status”: “active”}	Ko nga hua katoa me te whakauru rei, haunga te 8063. Tirohia i raro nei.	> 4.1
Tangohia te mana o te Whakauru 1, te Whakauru 2 ranei.	HAERE	/api/info/input.relay1.status or /api/info/input.relay2.status	N/A	{“input.relay1.status”: “idle”} or {“input.relay1.status”: “active”}	8063	> 4.1
Tikina te rarangi oro files kua whakauruhia inaianei.	HAERE	/api/info/tonelist	N/A	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	Katoa	> 5.0
Tikina nga korero mo te taputapu ka whakaatuhia ki te wharangi Tūnga.	HAERE	/api/info/status	N/A	Te rarangi katoa o nga korero mai i te ripa Tūnga.	Katoa	> 5.4

Tikina nga korero hua e whakaatuhia ana ki te wharangi About.	HAERE	/api/info/mo	N/A	Ko nga korero katoa kei runga i te ripa About.	Katoa	> 5.4
Whakahohehia te strobe me nga tawhā tae me te tauira e hiahiatia ana.	POTANGA	/api/controls/strobe/start	tauira: {0 – 15} tae1: {puru, whero, amipere, matomato} tae2: {puru, whero, amipere, matomato} ledlvl: {1 – 255} pupuri: {pono, teka}	N/A	8128(G2) 8138 8190S	> 3.3
Kati te strobe.	POTANGA	/api/controls/strobe/stop	N/A	N/A	8128(G2) 8138 8190S	> 3.3
Whakatangihia tetahi oro kia kotahi, ka huri ranei.	POTANGA	/api/controls/tone/start	ara: {tone} ie. chime.wav koropiko: {true, false} ranei {0, 1} hei tauira {“path”:”chime.wav”, “loop”:true}	N/A	Kaikōrero 8301 8373 8028(G2) 8201 8039	> 3.3
Kati te reo.	POTANGA	/api/controls/tone/stop	N/A	N/A	Kaikōrero 8301 8373 8028(G2) 8201 8039	> 3.3
Waea atu ki te toronga waea me te karere kua tuhia i mua.	POTANGA	/api/controls/call/start	{“toronga”:”2099″, “tone”:”gong.wav”, “wawhanga”:”0″, “maxdur”:”10″}	N/A	Kaikōrero 8301 8410 8420	> 3.3
Whakamutua te waea.	POTANGA	/api/controls/call/stop	N/A	N/A	Kaikōrero 8301 8410 8420	> 3.3

Tīmatahia he waea wharangi kotahi-ara. Ka whiwhi te taputapu i te awa ororongo mai i te toronga o te whaainga.	POTANGA	/api/controls/call/page	{“toronga”:” ”}	N/A	Kaikōrero 8410 8420	> 5.3.4
Whakahoutia te pito mutunga.	POTANGA	/api/controls/reboot	N/A	N/A	Katoa	> 3.3
Wewete te tatau. Ko te "rohe" e whakahaere ana i te rei rohe "netdc1" e whakahaere ana i te kaiwhakahaere tatau whatunga mamao (8063)	POTANGA	/api/controls/door/unlock	doorid: {rohe, netdc1} * Kōwhiri	N/A	8039 8028(G2) 8201 8063	> 3.3
Maukati te tatau.	POTANGA	/api/controls/door/lock	doorid: {rohe, netdc1} * Kōwhiri	N/A	8039 8028(G2) 8201 8063	> 3.3
Whakahohehia te 24v aux out relay.	POTANGA	api/mana/24v/whakahohea	N/A	N/A	8063	> 5.0
Monokia te 24v aux out relay.	POTANGA	api/controls/24v/disable	N/A	N/A	8063	> 5.0
Whakahohehia te rei whakaputa.	POTANGA	/api/controls/relay/enable	N/A	N/A	8063	> 5.0
Monokia te rei whakaputa.	POTANGA	/api/controls/relay/disable	N/A	N/A	8063	> 5.0
Tirohia te tūmau mārō a Algo mō te putanga mārō hou.	POTANGA	/api/controls/upgrade/check	N/A	{“putanga”: “whakahoutia”} ranei {“putanga”: “ ”}	Katoa	> 4.1
Tirohia te tūmau mārō a Algo mō te putanga mārō hou me te whakahou ake ki tērā putanga.	POTANGA	/api/controls/upgrade/start	N/A	{“tuanga”: “whakahoutia”} ranei {“status”: “whakahou ”, “url”: url>} ranei {“tuanga”: “ ”}	Katoa	> 4.1
Whakaatuhia he whakaahua, tauira ranei ki te mata.	POTANGA	/api/controls/screen/start	Tirohia i raro	N/A	8410 8420	> 5.3.4
Kati te tauira mata ka hoki ki te mata taunoa.	POTANGA	/api/controls/screen/stop	N/A	N/A	8410 8420	> 5.3.4

Tīmataria anō te tono matua.	POTANGA	/api/controls/reload	N/A	N/A	Katoa	> 5.3.4
Tīmatahia te whakarongo ki te awa ororongo tika. Whirihorahia te tau tauranga e tukuna ana te awa.	POTANGA	/api/controls/rx/start	{“tauranga”: }	N/A	Katoa	> 5.3.4
Kati te whakarongo ki te roma ororongo tika.	POTANGA	/api/controls/rx/stop	N/A	N/A	Katoa	> 5.3.4
Tautuhia te aratau tuku maha.	PUTA	/api/state/mcast/update/	{“mode”:”kaituku”, “address”: , “tauranga”: , “type”:”rtp”} or {“mode”:”kaituku”, “address”: , “tauranga”: , “momo”:”poly”, “group”:1} **Tuhipoka**: Mena ka whakamahia nga mana/too/tmatanga i mua i tenei whakahau, ka purei te oro ma te whakamahi i nga tautuhinga o naianei i runga i te web UI.	N/A	8301	> 5.0
Whakauruhia he uara ki tetahi tawhā motuhake mai i te utu utu JSON.	PUTA	/api/tautuhinga	tawhā: {uara} hei tauira {“audio.page.vol”: “-3dB”}	N/A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Atanga Mana Maamaa (SCI) Tono

Ko nga whakahau SCI katoa he tono GET me nga tawhā noa "usi" me "admin" mo te motuhēhēnga.
Example:
Tikina http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Whakaahuatanga	URI	Tāpiri Utauta Tawhā	Hua	FW
Wewete te tatau. Ko te "rohe" e whakahaere ana i te rei rohe "netdc1" e whakahaere ana i te kaiwhakahaere tatau whatunga mamao (8063)	/sci/controls/do or/unlock	doorid: {rohe, netdc1} * Kōwhiri	8039 8028(G2) 8201 8063	> 3.3
Maukati te tatau.	/sci/controls/do or/lock	doorid: {rohe, netdc1} * Kōwhiri	8039 8028(G2) 8201 8063	> 3.3
Whakatangihia tetahi oro kia kotahi, ka huri ranei.	/sci/controls/to ne/start	ara: {tone} ie. chime.wav koropiko: {true, false} ranei {0, 1}	Katoa	> 3.3
Kati te reo.	/sci/controls/to ne/stop	N/A	Katoa	> 3.3
Whakahohehia te strobe me nga tawhā tae me te tauira e hiahiatia ana.	/sci/controls/strobe/start	tauira: {0 – 15} tae1: {puru, whero, amipere, matomato} tae2: {puru, whero, amipere, matomato} ledlvl: {1 – 255} pupuri: {pono, teka}	8128(G2) 8138 8190S	> 3.3
Kati te strobe.	/sci/controls/strobe/stop	N/A	8128(G2) 8138 8190S	> 3.3

Tuhinga / Rauemi

	ALGO RESTful API [pdf] Aratohu Kaiwhakamahi AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, API ONOA, ONOA, API
	ALGO RESTful API [pdf] Aratohu Kaiwhakamahi AL061-GU-CP000API-230717, API ATA, API ATA, API

Tohutoro

• Pukapuka Kaiwhakamahi