ALGO RESTful API

Bayanin Samfura: Jagorar API RESTful

Algo RESTful API yana bawa masu amfani damar samun dama, sarrafa, da jawo ayyuka akan Algo IP Endpoints akan hanyar sadarwar su ta hanyar buƙatun HTTP/HTTPS. Wannan daftarin aiki yana ba da ƙayyadaddun ƙayyadaddun tsarin ayyuka marasa jiha waɗanda za a iya amfani da su don mu'amala da na'urorin Algo. API ɗin yana goyan bayan HTTP/HTTPS GET, POST, da buƙatun PUT tare da lodin JSON.

Tabbatarwa

Akwai nau'ikan ingantattun abubuwa guda uku da ake samu tare da Algo RESTful API:

• Daidaitaccen tabbaci (an kunna ta tsohuwa)
• Tantance asali (na zaɓi)
• Babu hanyar tantancewa (ba a ba da shawarar ba; don dalilai na gwaji kawai)

Umarnin Amfani da samfur: API RESTful

Abubuwan da ake bukata

Kafin kunna API ɗin RESTful, tabbatar da cewa na'urar tana da haɗin Intanet don isa ga sabar NTP da aka riga aka tsara. Idan babu haɗin intanet, saita uwar garken NTP na gida kuma shigar da adireshin IP ɗin sa.

Kunna API ɗin RESTful

1. Shiga cikin na'urar web dubawa kuma kewaya zuwa Advanced Saituna Admin tab.
2. Gungura ƙasa zuwa sashin Tallafi na API kuma kunna API RESTful.
3. Saita kalmar sirrin da ake so (tsoho kalmar sirri: algo). Lura cewa daidaitaccen tabbaci yana kunna ta tsohuwa.

Bayar da Ƙimar Gaskiya (Na zaɓi)

1. A cikin web dubawa, kewaya zuwa shafin Maintenance System kuma zazzage tsarin file.
2. Bude sanyi file tare da kowane editan rubutu kuma ƙara layi mai zuwa: api.auth.basic = 1
3. Ajiye kuma loda tsarin da aka gyara file mayar da na'urar ta amfani da Mayar da Kanfigareshan File fasali a cikin shafin Maintenance System.

Ƙaddamar Babu Hanyar Tabbatarwa (Na zaɓi)

Don ba da damar hanyar tantancewa, bar RESTful API Password filin fanko. Ba a ba da shawarar wannan hanyar ba kuma yakamata a yi amfani da ita don dalilai na gwaji kawai saboda ba ta da tsaro.

Kunna Sauƙaƙan Interface Control (Na zaɓi)

1. A kan web dubawa, kewaya zuwa shafin Maintenance System kuma zazzage tsarin file.
2. Bude sanyi file ta amfani da editan rubutu kuma ƙara layi biyu. Canza kalmar sirri zuwa sha'awar ku.
3. Admin.web.sci = 1
4. Sci.admin.pwd =
5. Ajiye kuma loda tsarin da aka gyara file mayar da na'urar ta amfani da Mayar da Kanfigareshan File fasali a cikin shafin Maintenance System.

Tabbatar da Sampda Code

Da fatan za a yi imel support@algosolutions.com idan kuna son ma'auni ko ainihin tabbaci sampda kod.
Don ƙarin tallafi, kira 604-454-3792 ko kuma imel support@algosolutions.com

Bayanan Bayani

Lura
Bayanan kula yana nuna sabuntawa masu amfani, bayanai, da umarnin da yakamata a bi

Disclaimer

An yi imanin bayanin da ke cikin wannan takarda cikakke ne ta kowace fuska amma Algo ba ta da garanti. Bayanin yana iya canzawa ba tare da sanarwa ba kuma bai kamata a yi amfani da shi ta kowace hanya azaman alƙawari ta Algo ko wani alaƙa ko rassan sa ba. Algo da masu haɗin gwiwa da rassan sa ba su ɗauki alhakin kowane kurakurai ko ragi a cikin wannan takaddar ba. Ana iya fitar da sake fasalin wannan takaddar ko sabbin bugu nata don haɗa irin waɗannan canje-canje. Algo ba shi da alhakin lalacewa ko da'awar sakamakon kowane amfani da wannan jagorar ko irin waɗannan samfuran, software, firmware, da/ko hardware. Babu wani ɓangare na wannan takarda da za a iya sake bugawa ko watsa ta kowace hanya ko ta kowace hanya - lantarki ko inji - don kowane dalili ba tare da rubutacciyar izini daga Algo ba.
Don ƙarin bayani ko taimakon fasaha a Arewacin Amurka, tuntuɓi ƙungiyar tallafin Algo:

Tallafin Fasaha na Algo
1-604-454-3792
support@algosolutions.com

©2022 Algo alamar kasuwanci ce mai rijista ta Algo Communication Products Ltd.
Duka Hakkoki. Duk sauran alamun kasuwanci mallakin masu su ne. Duk ƙayyadaddun bayanai ana iya canzawa ba tare da sanarwa ba.

 JAMA'A

Gabatarwa

Wannan takaddun yana bayyana yadda za'a iya amfani da Algo RESTful API don samun dama, sarrafa, da jawo ayyuka akan Algo IP Endpoints akan hanyar sadarwar ku ta hanyar buƙatun HTTP/HTTPS, da ma wasu hanyoyin tabbatarwa daban-daban tare da matakan tsaro daban-daban. Tsarukan nema na iya yin hulɗa tare da na'urorin Algo ta hanyar ƙayyadaddun ƙayyadaddun tsarin ayyukan marasa jiha wanda aka ayyana a cikin wannan takaddar. Ana yin buƙatun zuwa URI na albarkatu tare da ɗaukar nauyin JSON kuma an ba da amsa JSON. HTTP/HTTPS SAMU, POST, da buƙatun PUT ana yin su don albarkatun URI tare da jigilar JSON (duba sashin umarni don jerin abubuwan biya).

 Tabbatarwa

Akwai nau'ikan tabbatattun abubuwa guda uku:

•  Standard (an shawarta)
•  Na asali
•  Babu (ba a ba da shawarar ba)

Madaidaicin Tantancewar yana amfani da Lambar Tabbatar da Saƙo na tushen Hash (HMAC) tare da SHA-256 da aka rufa masa asiri. Tabbacin asali yana amfani da rufaffen Base64 kuma yakamata a yi amfani da shi akan HTTPS kawai. Bai kamata a yi amfani da ingantaccen aiki kawai tare da matsananciyar kulawa ba saboda ba ta da tabbaci. Duba sashin Bukatun Tabbatarwa don ƙarin cikakkun bayanai.

SATA DA GIRMA

Abubuwan da ake bukata

•  Wannan takaddun yana ɗauka cewa ƙarshen ƙarshen Algo yana gudana sigar firmware 3.3 ko sama.
•  Bambancin lokaci tsakanin mai nema da na'urorin Algo yakamata ya kasance ƙasa da daƙiƙa 30 don amfani da ingantaccen tabbaci.
• Tabbatar da NTP (Network Time Protocol) yana aiki. Ana iya daidaita adiresoshin sabar NTP na al'ada a cikin Advanced Settings → Time tab.

Lura
Sabar NTP da aka riga aka tsara ana gudanar da su a bainar jama'a, saboda haka ana buƙatar haɗin intanet don isa gare ta. Idan babu haɗin intanet, saita uwar garken NTP na gida kuma shigar da adireshin IP ɗin sa.

• Tabbatar cewa an daidaita lokacin tsarin na'urar Algo zuwa yankin lokaci daidai. Ana iya yin wannan ta hanyar kewayawa zuwa Advanced Settings → Time tab.

 Kunna API ɗin RESTful

1. Shiga cikin web dubawa kuma kewaya zuwa Babban Saituna → Admin tab.
2. Gungura ƙasa zuwa sashin Tallafi na API, kunna API ɗin RESTful kuma saita kalmar wucewa kamar yadda ake so (maɓallin kalmar sirri: algo)
   Lura
   Ana kunna daidaitaccen tabbaci ta tsohuwa.

Kunna Tabbatar da Asali (Na zaɓi)

1. A cikin web dubawa, kewaya zuwa System → Maintenance tab kuma zazzage tsarin file.
2. Bude sanyi file tare da kowane editan rubutu kuma ƙara layi mai zuwa: api.auth.basic = 1
3.  Ajiye kuma loda tsarin da aka gyara file mayar da na'urar ta amfani da Mayar da Kanfigareshan File fasali a cikin System → Maintenance tab.

Babu Hanyar Tabbatarwa (Na zaɓi)

Don ba da damar hanyar tantancewa, bar RESTful API Password filin fanko. Ba a ba da shawarar wannan hanyar ba kuma yakamata a yi amfani da ita don dalilai na gwaji kawai saboda ba ta da tsaro.

Kunna Sauƙaƙan Interface Control (Na zaɓi)

1. A kan web dubawa, kewaya zuwa System → Maintenance tab kuma zazzage tsarin file.
2.  Bude sanyi file ta amfani da editan rubutu kuma ƙara layi biyu. Canza zuwa kalmar sirrin sha'awar ku. Admin.web.sci = 1
   Sci.admin.pwd =
3.  Ajiye kuma loda tsarin da aka gyara file mayar da na'urar ta amfani da Mayar da Kanfigareshan File fasali a cikin System → Maintenance tab.

ABUBUWAN INGANTATTU

Da fatan za a yi imel support@algosolutions.com idan kuna son ma'auni ko ainihin tabbaci sampda kod.

Madaidaicin Buƙatar Tabbatarwa tare da Kayan Aiki na JSON

Abubuwan da ake buƙata a buƙatun HTTP/HTTPS
> Nau'in abun ciki: "application/json"
Abun ciki-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Izini: hmac admin: [nonce]: [hmac_output]
Maganganun izini sun ƙunshi:

1. Zaren 'hmac admin' yana biye da colon':'.
2. Nonce – Ƙimar bazuwar ko mara maimaituwa, sai kuma hanji ':'.
3. Hmac_output - Wanda aka tsara ta RESTful API Password (maɓallin sirri) wanda aka saita akan na'urarka da shigarwar HMAC, kamar yadda yake ƙasa:
   [hanyar buqatar]: [request_uri]: [content_md5]: [content_type]:[lokacinamp]: [babu]

shigar da HMAC example: (ta amfani da 'algo' azaman maɓallin sirri)
POST:/api/controls/tone/fara:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Samar da HMAC tare da kalmar sirri da HMAC shigar da kirtani a matsayin narkewa ta amfani da SHA-256:
HMAC fitarwa example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Kwanan wata: rana, watan kwanan wata, shekara hr:min:sec GMT
Example
Kwanan wata: Alhamis, 22 ga Satumba, 2022 02:33:07 GMT
Madaidaicin ingantaccen aiki tare da kaya mai nauyi exampda:

 Madaidaicin Buƙatar Tabbatarwa Ba tare da Layin JSON ba

Daidai da 3.1 tare da abun ciki masu alaƙa / shigarwar hmac da aka tsallake.
Shigar da HMAC: [request_method]: [request_uri]: [lokaciamp]: [nonce] shigar da HMAc example: (ta amfani da 'algo' azaman maɓallin sirri)
SAMU:/api/settings/audio.page.vol:1601312252:49936
Ƙirƙirar HMAC tare da kalmar sirri da igiyoyin shigarwar HMAC ta amfani da SHA-256:
HMAC fitarwa example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Daidaitaccen ingantaccen aiki ba tare da kaya ba exampda:

 Buƙatun Tabbatarwa na asali

Ya kamata a yi amfani da wannan hanyar tantancewa da kulawa domin ba shi da tsaro fiye da daidaitattun hanyar.

Izini: Na asali [tushe64]
Exampda:
Izini: Babban YWRtaW46YWxnbwo=
Tabbacin asali misaliampda:

UMARNI

 Dokokin API RESTful

A ƙasa akwai jerin duk umarnin API masu goyan bayan.

Lura
Buƙatun PUT yana canzawa ko ƙirƙirar tushe na dindindin wanda zai tsira daga sake yi, yayin da buƙatar POST ke sarrafa na'urar don zaman yanzu.

Bayani	Hanya	URI	Kayan aiki Siga	Komawa Example	Samfura	FW
Maido da ƙimar takamaiman siga.	SAMU	/api/settings/[key-name] Ex./api/settings/audio.page.vol	N/A	{"audio.page.vol": "-18dB"}	Duka	> 3.3
Mayar da matakin amo da aka auna a decibels. Dole ne a kunna Rayyayar Hayaniyar Amo a cikin Saitunan asali -> Shafin fasali.	SAMU	/api/info/audio.noise.level	N/A	{"audio.noise.level": 72}	Masu iya magana suna Nuna masu magana	> 3.3
Cire matsayin tashar shigarwar relay.	SAMU	/api/info/input.relay.status	N/A	{"input.relay.status": "rago"} ko {"input.relay.status": "active"}	Duk samfuran tare da shigarwar relay, sai dai 8063. Duba ƙasa.	> 4.1
Cire matsayin Input 1 ko Input 2 tasha.	SAMU	/api/info/input.relay1.status ko /api/info/input.relay2.status	N/A	{"input.relay1.status": "rago"} ko {"input.relay1.status": "active"}	8063	> 4.1
Dawo lissafin sautin files a halin yanzu an shigar.	SAMU	/api/info/tonelist	N/A	{"tonelist":["bell-na.wav", "bell uk.wav", "buzzer.wav",…]}	Duka	> 5.0
Dawo bayanan na'urar da aka nuna akan shafin Hali.	SAMU	/api/info/status	N/A	Cikakken jerin bayanai daga Matsayin shafin.	Duka	> 5.4

Dawo da bayanin samfurin da aka nuna akan Game da shafi.	SAMU	/api/info/game da	N/A	Duk bayanan da aka gabatar akan About tab.	Duka	> 5.4
Kunna strobe tare da sigogin launi da abin da ake so.	POST	/api/controls/strobe/fara	tsari: {0-15} launi1: {blue, ja, amber, kore} launi2: {blue, ja, amber, kore} ledlvl: {1 - 255} riƙe: {gaskiya, ƙarya}	N/A	8128 (G2) 8138 8190S	> 3.3
Dakatar da ciwon.	POST	/api/controls/strobe/stop	N/A	N/A	8128 (G2) 8138 8190S	> 3.3
Kunna sauti sau ɗaya ko madauki shi.	POST	/api/controls/tone/fara	hanya: {tone} watau. chime.wav madauki: {gaskiya, ƙarya} ko {0, 1} misali {"hanya":"chime.wav", "madauki":gaskiya}	N/A	Masu magana 8301 8373 8028 (G2) 8201 8039	> 3.3
Dakatar da sautin.	POST	/api/controls/tone/stop	N/A	N/A	Masu magana 8301 8373 8028 (G2) 8201 8039	> 3.3
Kira tsawo na waya tare da saƙon da aka riga aka yi rikodi.	POST	/api/controls/kira/fara	{"tsawo":"2099", "tone":"gong.wav", "tazara":"0", "maxdur":"10"}	N/A	Masu magana 8301 8410 8420	> 3.3
Ƙare kiran.	POST	/api/controls/kira/stop	N/A	N/A	Masu magana 8301 8410 8420	> 3.3

Fara kiran shafi guda ɗaya. Na'urar za ta karɓi rafi mai jiwuwa daga tsawaita manufa.	POST	/api/controls/kira/shafi	{"tsawo":" ”}	N/A	Masu magana 8410 8420	> 5.3.4
Sake kunna wurin ƙarshen manufa.	POST	/api/controls/sake yi	N/A	N/A	Duka	> 3.3
Buɗe kofar. "na gida" yana sarrafa relay na gida "netdc1" yana sarrafa mai sarrafa ƙofar cibiyar sadarwa mai nisa (8063)	POST	/api/controls/kofa/buɗe	doorid: {local, netdc1} * Zabi	N/A	8039 8028 (G2) 8201 8063	> 3.3
Kulle kofar.	POST	/api/controls/kofa/kulle	doorid: {local, netdc1} * Zabi	N/A	8039 8028 (G2) 8201 8063	> 3.3
Kunna 24v aux out relay.	POST	api/controls/24v/ kunna	N/A	N/A	8063	> 5.0
Kashe 24v aux out relay.	POST	api/controls/24v/ kashe	N/A	N/A	8063	> 5.0
Kunna abin fitarwa.	POST	/api/controls/relay/enable	N/A	N/A	8063	> 5.0
Kashe fitar da fitarwa.	POST	/api/controls/relay/disable	N/A	N/A	8063	> 5.0
Bincika uwar garken firmware na Algo don sabon sigar firmware.	POST	/api/controls/upgrade/duba	N/A	{"version": "sabunta"} ko {"Sigar": " ”}	Duka	> 4.1
Bincika uwar garken firmware na Algo don sabon sigar firmware kuma haɓaka zuwa waccan sigar.	POST	/api/controls/upgrade/farawa	N/A	{"status": "sabunta"} ko {"status": "haɓakawa ","url”: url>} ko {"halaye": " ”}	Duka	> 4.1
Nuna hoto ko tsari akan allon.	POST	/api/controls/screen/fara	Duba kasa	N/A	8410 8420	> 5.3.4
Dakatar da tsarin allo kuma komawa zuwa tsohon allo.	POST	/api/controls/screen/stop	N/A	N/A	8410 8420	> 5.3.4

Sake kunna babban aikace-aikacen.	POST	/api/controls/sake saukewa	N/A	N/A	Duka	> 5.3.4
Fara sauraron rafi mai jiwuwa kai tsaye. Sanya lambar tashar tashar da ake aika rafi zuwa gare ta.	POST	/api/controls/rx/start	{"tashar ruwa": }	N/A	Duka	> 5.3.4
Dakatar da sauraron rafi mai jiwuwa kai tsaye.	POST	/api/controls/rx/stop	N/A	N/A	Duka	> 5.3.4
Saita yanayin multicast.	PUT	/api/state/mcast/update/	{"yanayin":"mai aikawa", "adireshi": , "tashar ruwa": , "nau'in":"rtp"} ko {"yanayin":"mai aikawa", "address": , "tashar ruwa": , "nau'in":"poly", "rukuni":1} **Lura**: Idan ana amfani da sarrafawa/sautin/fara kafin wannan umarni, sautin zai yi wasa ta amfani da saitunan yanzu akan web UI.	N/A	8301	> 5.0
Saka ƙima zuwa ƙayyadaddun ma'auni daga lodin JSON.	PUT	/api/saituna	siga: {daraja} misali {"audio.page.vol": "-3dB"}	N/A	8180 (G2) 8186 8190 8190S 8301 8373	> 3.3

 Umarni Mai Sauƙi Mai Sauƙi (SCI).

Duk umarnin SCI buƙatun GET ne kuma suna da sigogi gama gari "usi" da "admin" don tantancewa.
Exampda:
SAMU http:// /sci/controls/kofa/buɗe?usr=admin&pwd=algo&doorid=local

Bayani	URI	Ƙarin Kayan aiki Siga	Kayayyaki	FW
Buɗe kofar. "na gida" yana sarrafa relay na gida "netdc1" yana sarrafa mai sarrafa ƙofar cibiyar sadarwa mai nisa (8063)	/sci/controls/yi ko/buɗe	doorid: {local, netdc1} * Zabi	8039 8028 (G2) 8201 8063	> 3.3
Kulle kofar.	/sci/controls/yi ko/kulle	doorid: {local, netdc1} * Zabi	8039 8028 (G2) 8201 8063	> 3.3
Kunna sauti sau ɗaya ko madauki shi.	/sci/controls/to ne/fara	hanya: {tone} watau. chime.wav madauki: {gaskiya, ƙarya} ko {0, 1}	Duka	> 3.3
Dakatar da sautin.	/sci/controls/to ne/stop	N/A	Duka	> 3.3
Kunna strobe tare da sigogin launi da abin da ake so.	/sci/controls/strobe/fara	samfurin: {0 - 15} launi1: {blue, ja, amber, kore} launi 2: {blue, ja, amber, kore} ledlvl: {1 - 255} riƙewa: {gaskiya, ƙarya}	8128 (G2) 8138 8190S	> 3.3
Dakatar da ciwon.	/sci/controls/strobe/stop	N/A	8128 (G2) 8138 8190S	> 3.3

Takardu / Albarkatu

	ALGO RESTful API [pdf] Jagorar mai amfani AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, API RESTful, RESTful, API
	ALGO RESTful API [pdf] Jagorar mai amfani AL061-GU-CP000API-230717, RESTful API, RESTful, API

Magana

• Manual mai amfani