ALGO RESTful API

Informacioni i produktit: Udhëzuesi RESTful API

Algo RESTful API i lejon përdoruesit të aksesojnë, manipulojnë dhe aktivizojnë veprime në pikat përfundimtare të Algo IP në rrjetin e tyre përmes kërkesave HTTP/HTTPS. Ky dokument ofron një grup të njëtrajtshëm dhe të paracaktuar të operacioneve pa shtetësi që mund të përdoren për të bashkëvepruar me pajisjet Algo. API mbështet kërkesat HTTP/HTTPS GET, POST dhe PUT me ngarkesa JSON.

Autentifikimi

Ekzistojnë tre lloje vërtetimesh të disponueshme me Algo RESTful API:

• Vërtetimi standard (i aktivizuar si parazgjedhje)
• Vërtetimi bazë (opsionale)
• Asnjë metodë vërtetimi (nuk rekomandohet; vetëm për qëllime testimi)

Udhëzimet e përdorimit të produktit: RESTful API

Parakushtet

Përpara se të aktivizoni API-në RESTful, sigurohuni që pajisja të ketë një lidhje interneti për të arritur serverët NTP të para-konfiguruar. Nëse nuk ka lidhje interneti, konfiguroni një server lokal NTP dhe futni adresën e tij IP.

Aktivizimi i API-së RESTful

1. Hyni në pajisjen web ndërfaqja dhe lundroni te skedari Admin Advanced Settings.
2. Lëvizni poshtë në seksionin e Mbështetjes API dhe aktivizoni API-në RESTful.
3. Vendosni fjalëkalimin e dëshiruar (fjalëkalimi i parazgjedhur: algo). Vini re se vërtetimi standard është aktivizuar si parazgjedhje.

Aktivizimi i vërtetimit bazë (opsionale)

1. Në web ndërfaqja, lundroni në skedën "Mirëmbajtja e sistemit" dhe shkarkoni konfigurimin file.
2. Hapni konfigurimin file me çdo redaktues teksti dhe shtoni rreshtin e mëposhtëm: api.auth.basic = 1
3. Ruani dhe ngarkoni konfigurimin e modifikuar file kthehuni në pajisje duke përdorur Rivendosjen e konfigurimit File funksion në skedën "Mirëmbajtja e sistemit".

Aktivizimi i asnjë metode vërtetimi (opsionale)

Për të aktivizuar metodën pa vërtetim, lini bosh fushën RESTful API Password. Kjo metodë nuk rekomandohet dhe duhet të përdoret vetëm për qëllime testimi pasi nuk ofron siguri.

Aktivizimi i ndërfaqes së thjeshtë të kontrollit (opsionale)

1. Në web ndërfaqja, lundroni në skedën "Mirëmbajtja e sistemit" dhe shkarkoni konfigurimin file.
2. Hapni konfigurimin file duke përdorur një redaktues teksti dhe shtoni dy rreshta. Ndryshoni fjalëkalimin sipas dëshirës tuaj.
3. Admin.web.sci = 1
4. Sci.admin.pwd =
5. Ruani dhe ngarkoni konfigurimin e modifikuar file kthehuni në pajisje duke përdorur Rivendosjen e konfigurimit File funksion në skedën "Mirëmbajtja e sistemit".

Autentifikimi Sample Kodin

Ju lutemi dërgoni email support@algosolutions.com nëse dëshironi një vërtetim standard ose bazë sampkodin.
Për mbështetje shtesë, telefononi 604-454-3792 ose email support@algosolutions.com

Njoftimet informative

Shënim
Shënimi tregon përditësime, informacione dhe udhëzime të dobishme që duhen ndjekur

Mohim përgjegjësie

Informacioni i përmbajtur në këtë dokument besohet të jetë i saktë në të gjitha aspektet, por nuk garantohet nga Algo. Informacioni mund të ndryshojë pa paralajmërim dhe nuk duhet të interpretohet në asnjë mënyrë si një angazhim nga Algo ose ndonjë prej filialeve ose filialeve të tij. Algo dhe filialet dhe filialet e saj nuk marrin asnjë përgjegjësi për ndonjë gabim ose lëshim në këtë dokument. Rishikimet e këtij dokumenti ose botimet e reja të tij mund të lëshohen për të përfshirë ndryshime të tilla. Algo nuk merr përsipër asnjë përgjegjësi për dëmet ose pretendimet që rezultojnë nga çdo përdorim i këtij manuali ose produkteve, softuerëve, firmuerit dhe/ose pajisjeve të tilla. Asnjë pjesë e këtij dokumenti nuk mund të riprodhohet ose transmetohet në asnjë formë ose me çfarëdo mjeti – elektronik ose mekanik – për asnjë qëllim pa lejen me shkrim nga Algo.
Për informacion shtesë ose asistencë teknike në Amerikën e Veriut, ju lutemi kontaktoni ekipin mbështetës të Algo:

Mbështetje Teknike Algo
1-604-454-3792
support@algosolutions.com

©2022 Algo është një markë e regjistruar e Algo Communication Products Ltd.
Të gjitha të drejtat e rezervuara. Të gjitha markat e tjera tregtare janë pronë e pronarëve të tyre përkatës. Të gjitha specifikat mund të ndryshojnë pa paralajmërim.

 E PËRGJITHSHME

Hyrje

Ky dokument përshkruan se si Algo RESTful API mund të përdoret për të hyrë, manipuluar dhe aktivizuar veprimet në pikat përfundimtare të Algo IP në rrjetin tuaj nëpërmjet kërkesave HTTP/HTTPS, si dhe disa metodave të ndryshme vërtetimi me nivele të ndryshme sigurie. Sistemet kërkuese mund të ndërveprojnë me pajisjet Algo përmes një grupi uniform dhe të paracaktuar të operacioneve pa shtetësi të përcaktuara në këtë dokument. Kërkesat i bëhen URI-së së një burimi me ngarkesë JSON dhe nxjerrin një përgjigje JSON. Kërkesat HTTP/HTTPS GET, POST dhe PUT bëhen për të burimeve URI së bashku me ngarkesën JSON (shih seksionin e komandave për një listë të ngarkesave).

 Autentifikimi

Ekzistojnë tre lloje të vërtetimeve:

•  Standard (rekomandohet)
•  bazë
•  Asnjë (nuk rekomandohet)

Autentifikimi standard përdor një kod të vërtetimit të mesazheve të bazuara në Hash (HMAC) me një përmbledhje të koduar SHA-256. Autentifikimi bazë përdor kodimin Base64 dhe duhet të përdoret vetëm në HTTPS. Asnjë vërtetim nuk duhet të përdoret vetëm me kujdes të jashtëzakonshëm pasi nuk ofron vërtetim. Shikoni seksionin Kërkesat e vërtetimit për më shumë detaje.

KONFIGURIMI DHE KONFIGURIMI

Parakushtet

•  Ky dokument supozon se pika përfundimtare e Algo po ekzekuton versionin 3.3 të firmuerit ose më të lartë.
•  Diferenca kohore midis kërkuesit dhe pajisjeve Algo duhet të jetë më pak se 30 sekonda për të përdorur vërtetimin standard.
• Sigurohuni që NTP (Network Time Protocol) është në përdorim. Adresat e serverëve të personalizuar NTP mund të konfigurohen në skedën Cilësimet e Avancuara → Koha.

Shënim
Serverët e para-konfiguruar NTP janë të strehuar publikisht, prandaj kërkohet lidhja e internetit për ta arritur atë. Nëse nuk ka lidhje interneti, konfiguroni një server lokal NTP dhe futni adresën e tij IP.

• Sigurohuni që ora e sistemit të pajisjes Algo të jetë rregulluar në zonën e duhur kohore. Kjo mund të bëhet duke lundruar te cilësimet e avancuara → skeda Koha.

 Aktivizimi i API-së RESTful

1. Hyni në web ndërfaqja dhe lundroni te skedari Cilësimet e Avancuara → Admin.
2. Lëvizni poshtë në seksionin e Mbështetjes API, aktivizoni API-në RESTful dhe vendosni fjalëkalimin sipas dëshirës (fjalëkalimi i parazgjedhur: algo)
   Shënim
   Autentifikimi standard është aktivizuar si parazgjedhje.

Aktivizo vërtetimin bazë (opsionale)

1. Në web ndërfaqja, lundroni te skeda System → Maintenance dhe shkarkoni konfigurimin file.
2. Hapni konfigurimin file me çdo redaktues teksti dhe shtoni rreshtin e mëposhtëm: api.auth.basic = 1
3.  Ruani dhe ngarkoni konfigurimin e modifikuar file kthehuni në pajisje duke përdorur Rivendosjen e konfigurimit File funksion në skedën System → Maintenance.

Nuk ka metodë vërtetimi (opsionale)

Për të aktivizuar metodën pa vërtetim, lini bosh fushën RESTful API Password. Kjo metodë nuk rekomandohet dhe duhet të përdoret vetëm për qëllime testimi pasi nuk ofron siguri.

Aktivizimi i ndërfaqes së thjeshtë të kontrollit (opsionale)

1. Në web ndërfaqja, lundroni te skeda System → Maintenance dhe shkarkoni konfigurimin file.
2.  Hapni konfigurimin file duke përdorur një redaktues teksti dhe shtoni dy rreshta. Ndryshoni sipas fjalëkalimit të dëshiruar. Admin.web.sci = 1
   Sci.admin.pwd =
3.  Ruani dhe ngarkoni konfigurimin e modifikuar file kthehuni në pajisje duke përdorur Rivendosjen e konfigurimit File funksion në skedën System → Maintenance.

KËRKESAT PËR AUTENTIKIM

Ju lutemi dërgoni email support@algosolutions.com nëse dëshironi një vërtetim standard ose bazë sampkodin.

Kërkesë standarde e vërtetimit me një ngarkesë JSON

Titujt e kërkuar në kërkesën HTTP/HTTPS
> Lloji i përmbajtjes: "application/json"
> Përmbajtja-MD5: [content_md5] P.shample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Autorizim: hmac admin:[nonce]:[hmac_output]
Titujt e autorizimit përbëhen nga:

1. Vargu 'hmac admin' i ndjekur nga një dy pika ':'.
2. Nonce – Një vlerë e rastësishme ose që nuk përsëritet, e ndjekur nga një dy pika ':'.
3. Hmac_output – gjeneruar nga RESTful API Password (çelës sekret) i konfiguruar në pajisjen tuaj dhe hyrja HMAC, si më poshtë:
   [metoda_kërkese]:[kërkesa_uri]:[përmbajtja_md5]:[lloji_përmbajtje]:[kohaamp]:[asnjë]

Hyrja HMAC p.shample: (duke përdorur 'algo' si çelës sekret)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Gjeneroni HMAC me fjalëkalim dhe vargun e hyrjes HMAC si përmbledhje duke përdorur SHA-256:
Dalja HMAC p.shample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Data: dita, data muaj, viti ora:min:sek GMT
Example
Data: e enjte, 22 shtator 2022 02:33:07 GMT
Autentifikimi standard me ngarkesë p.shampe:

 Kërkesë standarde për vërtetim pa ngarkesë JSON

Ident me 3.1 me titujt e lidhur me përmbajtjen/hyrjen hmac të hequra.
Hyrja HMAC: [kërkesa_metoda]:[kërkesa_uri]:[kohaamp]:[nonce] Hyrja HMAC p.shample: (duke përdorur 'algo' si çelës sekret)
GET:/api/settings/audio.page.vol:1601312252:49936
Gjeneroni HMAC me fjalëkalim dhe varg të hyrjes HMAC duke përdorur SHA-256:
Dalja HMAC p.shample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Autentifikimi standard pa ngarkesë p.shampe:

 Kërkesë bazë për vërtetim

Kjo metodë e vërtetimit duhet të përdoret me kujdes pasi është më pak e sigurt se metoda standarde.

Autorizimi: Bazë [bazë64]
Exampe:
Autorizimi: Basic YWRtaW46YWxnbwo=
Autentifikimi bazë p.shampe:

KOMANDA

 Komandat RESTful API

Më poshtë është një listë e të gjitha komandave të mbështetura API.

Shënim
Një kërkesë PUT ndryshon ose krijon një burim të përhershëm që i mbijeton një rindezjeje, ndërsa një kërkesë POST kontrollon pajisjen vetëm për seancën aktuale.

Përshkrimi	Metoda	URI	Ngarkesa Parametrat	Kthimi Example	Produkti	FW
Merrni vlerën e një parametri specifik.	MERRNI	/api/settings/[key-name] Shem./api/settings/audio.page.vol	N/A	{"audio.page.vol": "-18dB"}	Të gjitha	> 3.3
Ktheni nivelin e zhurmës së ambientit të matur në decibel. Kompensimi i zhurmës së ambientit duhet të aktivizohet te "Cilësimet bazë -> skeda "Veçoritë".	MERRNI	/api/info/audio.noise.level	N/A	{"audio.noise.level": 72}	Altoparlantët Shfaq Altoparlantët	> 3.3
Ekstraktoni statusin e terminalit të hyrjes së releit.	MERRNI	/api/info/input.relay.status	N/A	{"input.relay.status": "boshe"} ose {"input.relay.status": "aktiv"}	Të gjitha produktet me një hyrje rele, përveç 8063. Shihni më poshtë.	> 4.1
Ekstraktoni statusin e terminaleve Input 1 ose Input 2.	MERRNI	/api/info/input.relay1.status ose /api/info/input.relay2.status	N/A	{"input.relay1.status": "boshe"} ose {"input.relay1.status": "aktiv"}	8063	> 4.1
Merrni listën e tonit fileështë instaluar aktualisht.	MERRNI	/api/info/tonelist	N/A	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	Të gjitha	> 5.0
Merrni informacionin e pajisjes që shfaqet në faqen e statusit.	MERRNI	/api/info/status	N/A	Lista e plotë e informacionit nga skeda Status.	Të gjitha	> 5.4

Merrni informacionin e produktit që shfaqet në faqen Rreth.	MERRNI	/api/info/about	N/A	Të gjitha informacionet janë të pranishme në skedën Rreth.	Të gjitha	> 5.4
Aktivizoni strobin me parametrat e dëshiruar të ngjyrës dhe modelit.	POST	/api/controls/strobe/start	modeli: {0 - 15} ngjyra1: {blu, e kuqe, qelibar, jeshile} ngjyra2: {blu, e kuqe, qelibar, jeshile} ledlvl: {1 – 255} mbajtëse: {e vërtetë, e rreme}	N/A	8128 (G2) 8138 8190S	> 3.3
Ndaloni strobin.	POST	/api/controls/strobe/stop	N/A	N/A	8128 (G2) 8138 8190S	> 3.3
Luaj një ton një herë ose lakoje atë.	POST	/api/controls/ton/start	rruga: {ton} dmth. tingëllon.wav cikli: {true, false} ose {0, 1} p.sh. {“rruga”:”chime.wav”, “loop”:true}	N/A	Altoparlantët 8301 8373 8028 (G2) 8201 8039	> 3.3
Ndaloni tonin.	POST	/api/controls/ton/stop	N/A	N/A	Altoparlantët 8301 8373 8028 (G2) 8201 8039	> 3.3
Telefononi një shtesë telefoni me një mesazh të regjistruar paraprakisht.	POST	/api/controls/call/start	{“extension”:”2099″, “ton”:”gong.wav”, “interval”:”0″, “maxdur”:”10″}	N/A	Altoparlantët 8301 8410 8420	> 3.3
Përfundoni thirrjen.	POST	/api/controls/thirrje/ndal	N/A	N/A	Altoparlantët 8301 8410 8420	> 3.3

Filloni një telefonatë me faqe njëkahëshe. Pajisja do të marrë transmetimin audio nga shtrirja e synuar.	POST	/api/controls/call/page	{"zgjerim":" ”}	N/A	Altoparlantët 8410 8420	> 5.3.4
Rinisni pikën përfundimtare të synuar.	POST	/api/controls/reboot	N/A	N/A	Të gjitha	> 3.3
Zhbllokoni derën. "Local" kontrollon stafetën lokale "netdc1" kontrollon kontrolluesin e derës së rrjetit në distancë (8063)	POST	/api/kontrollet/dera/zhbllokimi	porta: {local, netdc1} * Opsionale	N/A	8039 8028 (G2) 8201 8063	> 3.3
Mbylle deren.	POST	/api/kontrollet/dera/kyçja	porta: {local, netdc1} * Opsionale	N/A	8039 8028 (G2) 8201 8063	> 3.3
Aktivizo rele 24v aux out.	POST	api/controls/24v/aktivizo	N/A	N/A	8063	> 5.0
Çaktivizo stafetën 24v aux out.	POST	api/controls/24v/disable	N/A	N/A	8063	> 5.0
Aktivizo stafetën e daljes.	POST	/api/kontrollet/rele/aktivizo	N/A	N/A	8063	> 5.0
Çaktivizoni stafetën e daljes.	POST	/api/kontrollet/rele/çaktivizoj	N/A	N/A	8063	> 5.0
Kontrolloni serverin e firmuerit të Algo për versionin më të fundit të firmuerit.	POST	/api/controls/upgrade/check	N/A	{“version”: “i përditësuar”} ose {"version": " ”}	Të gjitha	> 4.1
Kontrolloni serverin e firmuerit të Algo-s për versionin më të fundit të firmuerit dhe përmirësojeni në atë version.	POST	/api/controls/upgrade/start	N/A	{“status”: “i përditësuar”} ose {“status”: “përmirësim ", "url”: url>} ose {“statusi”: “ ”}	Të gjitha	> 4.1
Shfaqni një imazh ose model në ekran.	POST	/api/controls/ekran/start	Shihni më poshtë	N/A	8410 8420	> 5.3.4
Ndalo modelin e ekranit dhe kthehu në ekranin e paracaktuar.	POST	/api/kontrollet/ekran/stop	N/A	N/A	8410 8420	> 5.3.4

Rinisni aplikacionin kryesor.	POST	/api/kontrollet/ringarkoni	N/A	N/A	Të gjitha	> 5.3.4
Filloni të dëgjoni një transmetim të drejtpërdrejtë audio. Konfiguro numrin e portit në të cilin po dërgohet transmetimi.	POST	/api/controls/rx/start	{“port”: }	N/A	Të gjitha	> 5.3.4
Ndalo dëgjimin e një transmetimi të drejtpërdrejtë audio.	POST	/api/controls/rx/stop	N/A	N/A	Të gjitha	> 5.3.4
Vendosni modalitetin multicast.	VENDOSJE	/api/state/mcast/update/	{“mode”:”dërguesi”, “adresa”: , "port": , “type”:”rtp”} ose {“mode”:”dërguesi”, “adresa”: , "port": , "type":"poli", "grup":1} **Shënim**: Nëse kontrollet/ton/fillimi përdoret përpara kësaj komande, toni do të luhet duke përdorur cilësimet aktuale në web UI	N/A	8301	> 5.0
Futni një vlerë në një parametër specifik nga ngarkesa JSON.	VENDOSJE	/api/cilësimet	parametër: {value} p.sh. {"audio.page.vol": "-3dB"}	N/A	8180 (G2) 8186 8190 8190S 8301 8373	> 3.3

 Komandat e ndërfaqes së thjeshtë të kontrollit (SCI).

Të gjitha komandat SCI janë kërkesa GET dhe kanë parametrat e përbashkët "usi" dhe "admin" për vërtetim.
Exampe:
MERR http:// /sci/controls/door/zhbllokohet?usr=admin&pwd=algo&doorid=local

Përshkrimi	URI	Shtesë Ngarkesa Parametrat	Produktet	FW
Zhbllokoni derën. "Local" kontrollon stafetën lokale "netdc1" kontrollon kontrolluesin e derës së rrjetit në distancë (8063)	/sci/controls/bëj ose/zhblloko	porta: {local, netdc1} * Opsionale	8039 8028 (G2) 8201 8063	> 3.3
Mbylle deren.	/sci/controls/do ose/lock	porta: {local, netdc1} * Opsionale	8039 8028 (G2) 8201 8063	> 3.3
Luaj një ton një herë ose lakoje atë.	/sci/controls/to ne/start	rruga: {ton} dmth. tingëllon.wav cikli: {true, false} ose {0, 1}	Të gjitha	> 3.3
Ndaloni tonin.	/sci/controls/to ne/stop	N/A	Të gjitha	> 3.3
Aktivizoni strobin me parametrat e dëshiruar të ngjyrës dhe modelit.	/sci/controls/strobe/start	modeli: {0 – 15} ngjyra1: {blu, e kuqe, qelibar, jeshile} ngjyra 2: {blu, e kuqe, qelibar, jeshile} ledlvl: {1 – 255} mbajtëse: {e vërtetë, e rreme}	8128 (G2) 8138 8190S	> 3.3
Ndaloni strobin.	/sci/controls/strobe/stop	N/A	8128 (G2) 8138 8190S	> 3.3

Dokumentet / Burimet

	ALGO RESTful API [pdfUdhëzuesi i përdoruesit AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, API RESTful, RESTful, API
	ALGO RESTful API [pdfUdhëzuesi i përdoruesit AL061-GU-CP000API-230717, API RESTful, RESTful, API

Referencat

• Manuali i Përdoruesit