ALGO RESTful APIa

Produktuaren informazioa: RESTful API gida

Algo RESTful APIari esker, erabiltzaileek beren sareko Algo IP Endpointetan ekintzak atzitu, manipulatu eta abiarazteko aukera dute HTTP/HTTPS eskaeren bidez. Dokumentu honek Algo gailuekin elkarreragiteko erabil daitezkeen estaturik gabeko eragiketa multzo uniforme eta aurrez zehaztua eskaintzen du. APIak HTTP/HTTPS GET, POST eta PUT eskaerak onartzen ditu JSON kargarekin.

Autentifikazioa

Hiru autentifikazio mota daude eskuragarri Algo RESTful APIarekin:

• Autentifikazio estandarra (lehenespenez gaituta)
• Oinarrizko autentifikazioa (aukerakoa)
• Ez dago autentifikazio metodorik (ez da gomendagarria; probak egiteko soilik)

Produktua erabiltzeko jarraibideak: RESTful APIa

Aurrebaldintzak

RESTful APIa gaitu aurretik, ziurtatu gailuak Interneteko konexioa duela aurrez konfiguratutako NTP zerbitzarietara iristeko. Interneteko konexiorik ez badago, konfiguratu NTP zerbitzari lokal bat eta idatzi bere IP helbidea.

RESTful APIa gaitzen

1. Hasi saioa gailuan web interfazea eta joan Ezarpen aurreratuak Admin fitxara.
2. Joan behera API laguntza atalera eta gaitu RESTful APIa.
3. Ezarri nahi duzun pasahitza (pasahitz lehenetsia: algo). Kontuan izan autentifikazio estandarra lehenespenez gaituta dagoela.

Oinarrizko autentifikazioa gaitzea (aukerakoa)

1. urtean web interfazea, joan Sistema Mantentze fitxara eta deskargatu konfigurazioa file.
2. Ireki konfigurazioa file edozein testu-editorearekin eta gehitu lerro hau: api.auth.basic = 1
3. Gorde eta kargatu aldatutako konfigurazioa file itzuli gailura Berreskuratu konfigurazioa erabiliz File Sistemaren Mantentze fitxan eginbidea.

Ez autentifikazio-metodoa gaitu (aukerakoa)

Autentifikaziorik gabeko metodoa gaitzeko, utzi RESTful APIaren pasahitza eremua hutsik. Metodo hau ez da gomendagarria eta probak egiteko soilik erabili behar da, ez baitu segurtasunik ematen.

Kontrol-interfaze sinplea gaitzea (aukerakoa)

1. On web interfazea, joan Sistema Mantentze fitxara eta deskargatu konfigurazioa file.
2. Ireki konfigurazioa file testu-editore bat erabiliz eta gehitu bi lerro. Aldatu nahi duzun pasahitzarekin.
3. Admin.web.sci = 1
4. Sci.admin.pwd =
5. Gorde eta kargatu aldatutako konfigurazioa file itzuli gailura Berreskuratu konfigurazioa erabiliz File Sistemaren Mantentze fitxan eginbidea.

Autentifikazioa Sample Kodea

Mesedez, mezu elektronikoa support@algosolutions.com estandar edo oinarrizko autentifikazio s nahi baduzuample kodea.
Laguntza gehigarrirako, deitu 604-454-3792 edo posta elektronikoa support@algosolutions.com

Informazio Oharra

Oharra
Oharrak jarraitu beharreko eguneratze, informazio eta argibide erabilgarriak adierazten ditu

Erantzukizuna

Dokumentu honetan jasotako informazioa alderdi guztietan zehatza dela uste da, baina ez du Algok bermatzen. Informazioa jakinarazpenik gabe alda daiteke eta ez da inola ere ulertu behar Algoren edo bere afiliatuen edo filialen konpromiso gisa. Algok eta bere afiliatuek eta filialek ez dute bere gain hartzen dokumentu honetako akatsen edo hutsegiteen erantzukizunik. Dokumentu honen berrikuspenak edo haren edizio berriak egin daitezke aldaketa horiek sartzeko. Algok ez du bere gain hartzen eskuliburu honen edo produktu, software, firmware eta/edo hardwarearen edozein erabileraren ondoriozko kalteen edo erreklamazioen erantzukizunik. Dokumentu honen zatirik ezin da erreproduzitu edo transmititu inolaz ere edo inolaz ere (elektronikoa edo mekanikoa) helburuetarako, Algoren idatzizko baimenik gabe.
Ipar Amerikan informazio gehiago edo laguntza teknikoa lortzeko, jarri harremanetan Algo-ren laguntza-taldearekin:

Algo Laguntza Teknikoa
1-604-454-3792
support@algosolutions.com

©2022 Algo Algo Communication Products Ltd-ren marka erregistratua da.
Eskubide guztiak erreserbatuak. Gainerako marka guztiak dagozkien jabeen jabetzakoak dira. Zehaztapen guztiak abisurik gabe alda daitezke.

 OROKORRA

Sarrera

Dokumentu honek deskribatzen du nola erabil daitekeen Algo RESTful API zure sareko Algo IP Endpoint-en ekintzak atzitzeko, manipulatzeko eta abiarazteko HTTP/HTTPS eskaeren bidez, baita segurtasun-maila ezberdineko autentifikazio-metodo pare bat ere. Eskaerak egiten dituzten sistemek Algo gailuekin elkarreragin dezakete dokumentu honetan definitutako estaturik gabeko eragiketa multzo uniforme eta aurrez zehaztu baten bidez. Eskaerak baliabide baten URIra egiten dira JSON karga batekin eta JSON erantzuna lortzen dute. HTTP/HTTPS GET, POST eta PUT eskaerak JSON kargarekin batera baliabide URIrako egiten dira (ikus komandoen atala karga-zerrenda bat ikusteko).

 Autentifikazioa

Hiru autentifikazio mota daude:

•  Estandarra (gomendatua)
•  Oinarrizkoa
•  Bat ere ez (ez gomendatua)

Autentifikazio estandarrak Hash-en oinarritutako mezuen autentifikazio-kode bat (HMAC) erabiltzen du, SHA-256 kodetutako laburpen batekin. Oinarrizko autentifikazioak Base64 kodeketa erabiltzen du eta HTTPS bidez soilik erabili behar da. Ez da autentifikaziorik kontu handiz erabili behar, ez baitu autentifikaziorik ematen. Ikusi Autentifikazio-eskakizunak atala xehetasun gehiago lortzeko.

KONFIGURAZIOA ETA KONFIGURAZIOA

Aurrebaldintzak

•  Dokumentu honek suposatzen du Algo amaierako puntuak 3.3 firmware bertsioa edo berriagoa exekutatzen duela.
•  Eskatzailearen eta Algo gailuen arteko denbora-aldea 30 segundo baino txikiagoa izan behar da autentifikazio estandarra erabiltzeko.
• Ziurtatu NTP (Network Time Protocol) erabiltzen ari dela. NTP zerbitzari pertsonalizatuen helbideak Ezarpen aurreratuak → Ordua fitxan konfigura daitezke.

Oharra
Aurrez konfiguratutako NTP zerbitzariak publikoki ostatatuta daude, beraz, Interneteko konexioa beharrezkoa da bertara iristeko. Interneteko konexiorik ez badago, konfiguratu NTP zerbitzari lokal bat eta idatzi bere IP helbidea.

• Ziurtatu Algo gailuaren sistemaren ordua ordu-eremu egokira egokitzen dela. Hau egin daiteke Ezarpen aurreratuak → Ordua fitxara nabigatuz.

 RESTful APIa gaitzen

1. Hasi saioa web interfazea eta joan Ezarpen aurreratuak → Admin fitxara.
2. Joan behera API laguntza atalera, gaitu RESTful APIa eta ezarri Pasahitza nahi duzun moduan (pasahitz lehenetsia: algo)
   Oharra
   Autentifikazio estandarra gaituta dago lehenespenez.

Gaitu oinarrizko autentifikazioa (aukerakoa)

1. urtean web interfazea, joan Sistema → Mantentze fitxara eta deskargatu konfigurazioa file.
2. Ireki konfigurazioa file edozein testu-editorearekin eta gehitu lerro hau: api.auth.basic = 1
3.  Gorde eta kargatu aldatutako konfigurazioa file itzuli gailura Berreskuratu konfigurazioa erabiliz File eginbidea Sistema → Mantentzea fitxan.

Ez dago autentifikazio metodorik (aukerakoa)

Autentifikaziorik gabeko metodoa gaitzeko, utzi RESTful APIaren pasahitza eremua hutsik. Metodo hau ez da gomendagarria eta probak egiteko soilik erabili behar da, ez baitu segurtasunik ematen.

Kontrol-interfaze sinplea gaitzea (aukerakoa)

1. On web interfazea, joan Sistema → Mantentze fitxara eta deskargatu konfigurazioa file.
2.  Ireki konfigurazioa file testu-editore bat erabiliz eta gehitu bi lerro. Aldatu nahi duzun pasahitzera. Admin.web.sci = 1
   Sci.admin.pwd =
3.  Gorde eta kargatu aldatutako konfigurazioa file itzuli gailura Berreskuratu konfigurazioa erabiliz File eginbidea Sistema → Mantentzea fitxan.

Autentikazio-baldintzak

Mesedez, mezu elektronikoa support@algosolutions.com estandar edo oinarrizko autentifikazio s nahi baduzuample kodea.

Autentifikazio-eskaera estandarra JSON karga batekin

Beharrezko goiburuak HTTP/HTTPS eskaeran
> Eduki mota: "aplikazioa/json"
> Edukia-MD5: [edukia_md5] Adibample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Baimena: hmac admin:[nonce]:[hmac_output]
Baimenaren goiburuak hauek dira:

1. 'hmac admin' katea eta bi bi puntuz ':'.
2. Nonce – Ausazko balio bat edo errepikatzen ez den balio bat, eta ondoren bi puntu bat ':'.
3. Hmac_output - Zure gailuan konfiguratutako RESTful API pasahitzarekin (gako sekretua) eta HMAC sarrerarekin sortutakoa, beheko moduan:
   [request_method]:[request_uri]:[content_md5]:[content_type]:[denbora gehienaamp]:[inoiz]

HMAC sarrera adibidezample: ('algo' erabiliz gako sekretu gisa)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Sortu HMAC pasahitzarekin eta HMAC sarrera-katearekin laburpen gisa SHA-256 erabiliz:
HMAC irteera adibidezample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Data: eguna, data hilabetea, urtea hr:min:sec GMT
Example
Data: 22ko irailaren 2022a, 02:33:07 GMT
Autentifikazio estandarra karga kargarekin adibidezample:

 Autentifikazio-eskaera estandarra JSON kargarik gabe

3.1-aren berdina edukiarekin erlazionatutako goiburuak/hmac sarrera baztertuta.
HMAC sarrera: [request_method]:[request_uri]:[denboraamp]:[nonce] HMAC sarrera adibidezample: ('algo' erabiliz gako sekretu gisa)
GET:/api/settings/audio.page.vol:1601312252:49936
Sortu HMAC pasahitzarekin eta HMAC sarrera-katearekin SHA-256 erabiliz:
HMAC irteera adibidezample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Kargarik gabeko autentifikazio estandarra adibidezample:

 Oinarrizko autentifikazio-eskaera

Autentifikazio-metodo hau kontu handiz erabili behar da, metodo estandarra baino seguruagoa baita.

Baimena: Oinarrizkoa [base64]
Example:
Baimena: Oinarrizko YWRtaW46YWxnbwo=
Oinarrizko autentifikazioa adibidezample:

KANDOAK

 RESTful API komandoak

Jarraian, onartzen diren API komando guztien zerrenda dago.

Oharra
PUT eskaera batek berrabiarazten duen baliabide iraunkor bat aldatzen edo sortzen du, eta POST eskaera batek uneko saiorako gailua soilik kontrolatzen du.

Deskribapena	Metodoa	URI	Karga erabilgarria Parametroak	Itzuli Example	Produktua	FW
Berreskuratu parametro zehatz baten balioa.	LORTU	/api/settings/[gako-izena] Adib./api/settings/audio.page.vol	N/A	{“audio.page.vol”: “-18dB”}	Denak	> 3.3
Itzuli dezibeletan neurtutako inguruneko zarata maila. Inguruko zarataren konpentsazioa Oinarrizko Ezarpenak -> Ezaugarriak fitxan gaitu behar da.	LORTU	/api/info/audio.noise.level	N/A	{“audio.noise.level”: 72}	Bozgorailuak Erakutsi bozgorailuak	> 3.3
Atera errelearen sarrerako terminalaren egoera.	LORTU	/api/info/input.relay.status	N/A	{“input.relay.status”: “inaktibo”} edo {“input.relay.status”: “aktibo”}	Errele sarrera duten produktu guztiak, 8063 izan ezik. Ikus behean.	> 4.1
Atera 1. sarrerako edo 2. sarrerako terminalen egoera.	LORTU	/api/info/input.relay1.status edo /api/info/input.relay2.status	N/A	{“input.relay1.status”: “inaktibo”} edo {“input.relay1.status”: “aktibo”}	8063	> 4.1
Berreskuratu tonuen zerrenda fileune honetan instalatuta dago.	LORTU	/api/info/tonelist	N/A	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	Denak	> 5.0
Berreskuratu Egoera orrian bistaratzen den gailuaren informazioa.	LORTU	/api/info/status	N/A	Informazioaren zerrenda osoa Egoera fitxatik.	Denak	> 5.4

Berreskuratu Honi buruz orrian bistaratzen den produktuaren informazioa.	LORTU	/api/info/about	N/A	Honi buruz fitxan dagoen informazio guztia.	Denak	> 5.4
Aktibatu estrobokoa nahi dituzun kolore eta eredu parametroekin.	POST	/api/controls/strobe/start	eredua: {0 - 15} color1: {urdina, gorria, anbarra, berdea} color2: {urdina, gorria, anbarra, berdea} ledlvl: {1 – 255} hondarra: {egia, gezurra}	N/A	8128 (G2) 8138 8190S	> 3.3
Gelditu estroboscopioa.	POST	/api/controls/strobe/stop	N/A	N/A	8128 (G2) 8138 8190S	> 3.3
Jo ezazu tonu bat behin edo begiztatu.	POST	/api/controls/tone/start	bide: {tonua} ie. txirrin.wav begizta: {egia, gezurra} edo {0, 1} adibidez {“bidea”:”chime.wav”, “begizta”: egia}	N/A	Hiztunak 8301 8373 8028 (G2) 8201 8039	> 3.3
Gelditu tonua.	POST	/api/controls/tone/stop	N/A	N/A	Hiztunak 8301 8373 8028 (G2) 8201 8039	> 3.3
Deitu telefono-luzapen bati aurrez grabatutako mezu batekin.	POST	/api/controls/call/start	{“extension”:”2099″, “tonua”:”gong.wav”, “tartea”:”0″, “maxdur”:”10″}	N/A	Hiztunak 8301 8410 8420	> 3.3
Amaitu deia.	POST	/api/controls/call/stop	N/A	N/A	Hiztunak 8301 8410 8420	> 3.3

Hasi norabide bakarreko orrialde-deia. Gailuak audio-korrontea jasoko du xede-luzapenetik.	POST	/api/controls/call/page	{“luzapena”:” ”}	N/A	Hiztunak 8410 8420	> 5.3.4
Berrabiarazi xede amaierako puntua.	POST	/api/controls/berrabiarazi	N/A	N/A	Denak	> 3.3
Desblokeatu atea. "local" errele lokala kontrolatzen du "netdc1" urruneko sareko ate kontrolatzailea kontrolatzen du (8063)	POST	/api/controls/atea/desblokeatu	atea: {lokal, netdc1} * Aukerakoa	N/A	8039 8028 (G2) 8201 8063	> 3.3
Atea itxi.	POST	/api/controls/atea/blokea	atea: {lokal, netdc1} * Aukerakoa	N/A	8039 8028 (G2) 8201 8063	> 3.3
Gaitu 24 V-ko irteteko errelea.	POST	api/controls/24v/enable	N/A	N/A	8063	> 5.0
Desgaitu 24 V-ko irteerako errele aux.	POST	api/kontrolak/24v/desgaitu	N/A	N/A	8063	> 5.0
Gaitu irteerako errelea.	POST	/api/controls/relay/enable	N/A	N/A	8063	> 5.0
Desgaitu irteerako errelea.	POST	/api/controls/relay/disable	N/A	N/A	8063	> 5.0
Egiaztatu Algoren firmware zerbitzaria azken firmware bertsioa ikusteko.	POST	/api/controls/upgrade/check	N/A	{“bertsioa”: “eguneratua”} edo {“bertsioa”: “ ”}	Denak	> 4.1
Egiaztatu Algo-ren firmware zerbitzarian azken firmware bertsioa eta eguneratu bertsio horretara.	POST	/api/controls/upgrade/start	N/A	{“egoera”: “eguneratua”} edo {“status”: “berritzen ”, “url”: url>> edo {“egoera”: “ ”}	Denak	> 4.1
Bistaratu irudi edo eredu bat pantailan.	POST	/api/controls/screen/start	Ikusi behean	N/A	8410 8420	> 5.3.4
Gelditu pantaila eredua eta itzuli pantaila lehenetsira.	POST	/api/controls/screen/stop	N/A	N/A	8410 8420	> 5.3.4

Berrabiarazi aplikazio nagusia.	POST	/api/controls/reload	N/A	N/A	Denak	> 5.3.4
Hasi zuzeneko audio-korronte bat entzuten. Konfiguratu korrontea bidaltzen den ataka-zenbakia.	POST	/api/controls/rx/start	{“portua”: }	N/A	Denak	> 5.3.4
Utzi zuzeneko audio-korronte bat entzuteari.	POST	/api/controls/rx/stop	N/A	N/A	Denak	> 5.3.4
Ezarri multicast modua.	JARRI	/api/state/mcast/update/	{“mode”:”igorlea”, “helbidea”: , "portua": , "mota":"rtp"} edo {"modua":"igorlea", "helbidea": , "portua": , "mota":"polio", "taldea":1} **Oharra**: komando honen aurretik kontrolak/tonua/hasiera erabiltzen bada, tonua uneko ezarpenak erabiliz joko da. web UI.	N/A	8301	> 5.0
Txertatu balio bat JSON kargaren parametro zehatz batean.	JARRI	/api/ezarpenak	parametroa: {balioa} adibidez {“audio.page.vol”: “-3dB”}	N/A	8180 (G2) 8186 8190 8190S 8301 8373	> 3.3

 Simple Control Interface (SCI) komandoak

SCI komando guztiak GET eskaerak dira eta "usi" eta "admin" parametro komunak dituzte autentifikaziorako.
Example:
Lortu http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Deskribapena	URI	Gehigarria Karga erabilgarria Parametroak	Produktuak	FW
Desblokeatu atea. "local" errele lokala kontrolatzen du "netdc1" urruneko sareko ate kontrolatzailea kontrolatzen du (8063)	/sci/controls/do edo/desblokeatu	atea: {lokal, netdc1} * Aukerakoa	8039 8028 (G2) 8201 8063	> 3.3
Atea itxi.	/sci/kontrolak/egin edo/blokeatu	atea: {lokal, netdc1} * Aukerakoa	8039 8028 (G2) 8201 8063	> 3.3
Jo ezazu tonu bat behin edo begiztatu.	/sci/controls/to ne/hasi	bide: {tonua} ie. txirrin.wav begizta: {egia, gezurra} edo {0, 1}	Denak	> 3.3
Gelditu tonua.	/sci/controls/to ne/stop	N/A	Denak	> 3.3
Aktibatu estrobokoa nahi dituzun kolore eta eredu parametroekin.	/sci/controls/strobe/hasiera	eredua: {0 – 15} kolorea1: {urdina, gorria, anbarra, berdea} kolorea2: {urdina, gorria, anbarra, berdea} ledlvl: {1 – 255} holdover: {egia, gezurra}	8128 (G2) 8138 8190S	> 3.3
Gelditu estroboscopioa.	/sci/controls/strobe/stop	N/A	8128 (G2) 8138 8190S	> 3.3

Dokumentuak / Baliabideak

	ALGO RESTful APIa [pdfErabiltzailearen gida AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful APIa [pdfErabiltzailearen gida AL061-GU-CP000API-230717, RESTful API, RESTful, API

Erreferentziak

• Erabiltzailearen eskuliburua