ALGO RESTful API

Informazzjoni dwar il-Prodott: Gwida API RESTful

L-API Algo RESTful tippermetti lill-utenti jaċċessaw, jimmanipulaw, u jqanqlu azzjonijiet fuq Algo IP Endpoints fuq in-netwerk tagħhom permezz ta' talbiet HTTP/HTTPS. Dan id-dokument jipprovdi sett uniformi u predefinit ta 'operazzjonijiet mingħajr stat li jistgħu jintużaw biex jinteraġixxu ma' apparati Algo. L-API tappoġġja talbiet HTTP/HTTPS GET, POST, u PUT bi payloads JSON.

Awtentikazzjoni

Hemm tliet tipi ta' awtentikazzjoni disponibbli bl-API Algo RESTful:

• Awtentikazzjoni standard (attivata awtomatikament)
• Awtentikazzjoni bażika (mhux obbligatorja)
• L-ebda metodu ta' awtentikazzjoni (mhux rakkomandat; għal skopijiet ta' ttestjar biss)

Struzzjonijiet għall-Użu tal-Prodott: API RESTful

Prerekwiżiti

Qabel ma tippermetti l-API RESTful, kun żgur li l-apparat ikollu konnessjoni tal-internet biex jilħaq is-servers NTP konfigurati minn qabel. Jekk ma tkun disponibbli l-ebda konnessjoni tal-internet, ikkonfigura server NTP lokali u daħħal l-indirizz IP tiegħu.

Jippermettu l-API RESTful

1. Idħol fil-mezz web interface u naviga għat-tab Admin Settings Avvanzati.
2. Skrollja 'l isfel sas-sezzjoni ta' Appoġġ tal-API u ppermetti l-API RESTful.
3. Issettja l-password mixtieqa (password default: algo). Innota li l-awtentikazzjoni standard hija attivata b'mod awtomatiku.

Attivazzjoni tal-Awtentikazzjoni Bażika (Mhux obbligatorju)

1. Fil- web interface, naviga għat-tab tal-Manutenzjoni tas-Sistema u niżżel il-konfigurazzjoni file.
2. Iftaħ il-konfigurazzjoni file bi kwalunkwe editur tat-test u żid il-linja li ġejja: api.auth.basic = 1
3. Issejvja u ittella' l-konfigurazzjoni modifikata file lura lill-apparat billi tuża l-Konfigurazzjoni Restore File karatteristika fit-tab Manutenzjoni tas-Sistema.

Li Jippermettu l-Ebda Metodu ta' Awtentikazzjoni (Mhux obbligatorju)

Biex tippermetti l-metodu tal-ebda awtentikazzjoni, ħalli l-qasam tal-Password tal-API RESTful vojt. Dan il-metodu mhuwiex rakkomandat u għandu jintuża biss għal skopijiet ta 'ttestjar peress li ma jipprovdi l-ebda sigurtà.

Attivazzjoni ta' Interface ta' Kontroll Sempliċi (Mhux obbligatorju)

1. Fuq il- web interface, naviga għat-tab tal-Manutenzjoni tas-Sistema u niżżel il-konfigurazzjoni file.
2. Iftaħ il-konfigurazzjoni file billi tuża editur tat-test u żid żewġ linji. Ibdel il-password tax-xewqa tiegħek.
3. Amministratur.web.sci = 1
4. Sci.admin.pwd =
5. Issejvja u ittella' l-konfigurazzjoni modifikata file lura lill-apparat billi tuża l-Konfigurazzjoni Restore File karatteristika fit-tab Manutenzjoni tas-Sistema.

Awtentikazzjoni Sample Kodiċi

Jekk jogħġbok ibgħat email support@algosolutions.com jekk tixtieq awtentikazzjoni standard jew bażika sampil-kodiċi.
Għal appoġġ addizzjonali, ċempel 604-454-3792 jew email support@algosolutions.com

Avviżi ta' Informazzjoni

Nota
Nota tindika aġġornamenti utli, informazzjoni, u struzzjonijiet li għandhom jiġu segwiti

Ċaħda

L-informazzjoni li tinsab f'dan id-dokument hija maħsuba li hija preċiża fl-aspetti kollha iżda mhix iġġustifikata minn Algo. L-informazzjoni hija soġġetta għal bidla mingħajr avviż u m'għandha tiġi interpretata bl-ebda mod bħala impenn minn Algo jew kwalunkwe mill-affiljati jew sussidjarji tagħha. Algo u l-affiljati u s-sussidjarji tagħha ma jassumu l-ebda responsabbiltà għal xi żbalji jew ommissjonijiet f'dan id-dokument. Jistgħu jinħarġu reviżjonijiet ta' dan id-dokument jew edizzjonijiet ġodda tiegħu biex jinkorporaw tali bidliet. Algo ma jassumi l-ebda responsabbiltà għal danni jew pretensjonijiet li jirriżultaw minn kwalunkwe użu ta 'dan il-manwal jew tali prodotti, software, firmware, u/jew hardware. L-ebda parti minn dan id-dokument ma tista’ tiġi riprodotta jew trażmessa fi kwalunkwe forma jew b’xi mezz – elettroniku jew mekkaniku – għal kwalunkwe skop mingħajr permess bil-miktub minn Algo.
Għal informazzjoni addizzjonali jew assistenza teknika fl-Amerika ta’ Fuq, jekk jogħġbok ikkuntattja lit-tim ta’ appoġġ ta’ Algo:

Appoġġ Tekniku Algo
1-604-454-3792
support@algosolutions.com

©2022 Algo hija trademark reġistrata ta' Algo Communication Products Ltd.
Id-Drittijiet Kollha Riservati. It-trademarks l-oħra kollha huma l-proprjetà tas-sidien rispettivi tagħhom. L-ispeċifikazzjonijiet kollha huma soġġetti għal tibdil mingħajr avviż.

 ĠENERALI

Introduzzjoni

Dan id-dokument jiddeskrivi kif l-API RESTful Algo tista 'tintuża biex taċċessa, timmanipula, u tiskatta azzjonijiet fuq Endpoints tal-IP Algo fuq in-netwerk tiegħek permezz ta' talbiet HTTP/HTTPS, kif ukoll koppja ta 'metodi ta' awtentikazzjoni differenti b'livelli differenti ta 'sigurtà. Is-sistemi ta' talba jistgħu jinteraġixxu ma' apparati Algo permezz ta' sett uniformi u predefinit ta' operazzjonijiet mingħajr stat definiti f'dan id-dokument. It-talbiet isiru lill-URI ta' riżorsa b'tagħbija JSON u jqanqlu rispons JSON. It-talbiet HTTP/HTTPS GET, POST, u PUT isiru lill-URI tar-riżorsi flimkien mal-payload JSON (ara t-taqsima tal-kmandi għal-lista ta 'payloads).

 Awtentikazzjoni

Hemm tliet tipi ta’ awtentikazzjoni:

•  Standard (rakkomandat)
•  Bażiku
•  Xejn (mhux rakkomandat)

L-awtentikazzjoni Standard tuża Kodiċi ta' Awtentikazzjoni ta' Messaġġ ibbażat fuq Hash (HMAC) b'diġest kodifikat SHA-256. L-awtentikazzjoni bażika tuża kodifikazzjoni Base64 u għandha tintuża biss fuq HTTPS. L-ebda awtentikazzjoni m'għandha tintuża biss b'attenzjoni kbira peress li ma tipprovdi l-ebda awtentikazzjoni. Ara t-taqsima tar-Rekwiżiti tal-Awtentikazzjoni għal aktar dettalji.

SETUP U KONFIGURAZZJONI

Prerekwiżiti

•  Dan id-dokument jassumi li l-endpoint Algo qed iħaddem il-verżjoni tal-firmware 3.3 jew ogħla.
•  Id-differenza fil-ħin bejn min jagħmel it-talba u l-apparat Algo għandha tkun inqas minn 30 sekonda biex tuża awtentikazzjoni standard.
• Kun żgur li qed jintuża NTP (Network Time Protocol). L-indirizzi tas-servers NTP tad-dwana jistgħu jiġu kkonfigurati fit-tab Settings Avvanzati → Ħin.

Nota
Is-servers NTP konfigurati minn qabel huma ospitati pubblikament, għalhekk hija meħtieġa konnessjoni tal-internet biex tilħaqha. Jekk ma tkun disponibbli l-ebda konnessjoni tal-internet, ikkonfigura server NTP lokali u daħħal l-indirizz IP tiegħu.

• Żgura li l-ħin tas-sistema tal-apparat Algo huwa aġġustat għaż-żona tal-ħin korretta. Dan jista 'jsir billi tinnaviga fit-tab Settings Avvanzati → Ħin.

 Jippermettu l-API RESTful

1. Idħol fil- web interface u naviga għall-Settings Avvanzati → tab Amministratur.
2. Skrollja 'l isfel sas-sezzjoni ta' Appoġġ API, ppermetti l-API RESTful u ssettja l-Password kif mixtieq (password default: algo)
   Nota
   L-awtentikazzjoni standard hija attivata awtomatikament.

Ippermetti l-Awtentikazzjoni Bażika (Mhux obbligatorju)

1. Fil- web interface, innaviga lejn it-tab Sistema → Manutenzjoni u niżżel il-konfigurazzjoni file.
2. Iftaħ il-konfigurazzjoni file bi kwalunkwe editur tat-test u żid il-linja li ġejja: api.auth.basic = 1
3.  Issejvja u ittella' l-konfigurazzjoni modifikata file lura lill-apparat billi tuża l-Konfigurazzjoni Restore File karatteristika fit-tab Sistema → Manutenzjoni.

L-ebda Metodu ta' Awtentikazzjoni (Mhux obbligatorju)

Biex tippermetti l-metodu tal-ebda awtentikazzjoni, ħalli l-qasam tal-Password tal-API RESTful vojt. Dan il-metodu mhuwiex rakkomandat u għandu jintuża biss għal skopijiet ta 'ttestjar peress li ma jipprovdi l-ebda sigurtà.

Attivazzjoni ta' Interface ta' Kontroll Sempliċi (Mhux obbligatorju)

1. Fuq il- web interface, innaviga lejn it-tab Sistema → Manutenzjoni u niżżel il-konfigurazzjoni file.
2.  Iftaħ il-konfigurazzjoni file billi tuża editur tat-test u żid żewġ linji. Ibdel il- għall-password tax-xewqa tiegħek. Amministratur.web.sci = 1
   Sci.admin.pwd =
3.  Issejvja u ittella' l-konfigurazzjoni modifikata file lura lill-apparat billi tuża l-Konfigurazzjoni Restore File karatteristika fit-tab Sistema → Manutenzjoni.

REKWIŻITI TA' AWTENTIKAZZJONI

Jekk jogħġbok ibgħat email support@algosolutions.com jekk tixtieq awtentikazzjoni standard jew bażika sampil-kodiċi.

Talba ta' Awtentikazzjoni Standard b'Tagħbija JSON

Headers meħtieġa fit-talba HTTP/HTTPS
> Tip ta' Kontenut: "applikazzjoni/json"
> Kontenut-MD5: [content_md5] Eżample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Awtorizzazzjoni: hmac admin:[nonce]:[hmac_output]
L-intestaturi tal-awtorizzazzjoni jikkonsistu minn:

1. Is-sekwenza 'hmac admin' segwita minn kolon ':'.
2. Nonce – Valur każwali jew li ma jirrepetix, segwit minn kolon ':'.
3. Hmac_output – iġġenerat mill-Password tal-API RESTful (ċavetta sigrieta) ikkonfigurata fuq it-tagħmir tiegħek u l-input HMAC, kif hawn taħt:
   [request_method]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[għal darba]

Input HMAC example: (bl-użu 'algo' bħala ċ-ċavetta sigrieta)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Iġġenera HMAC bil-password u string input HMAC bħala digest billi tuża SHA-256:
Ħruġ HMAC example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Data: jum, data xahar, sena hr:min:sec GMT
Example
Data: Ħam, 22 ta' Settembru, 2022 02:33:07 GMT
Awtentikazzjoni standard b'tagħbija example:

 Talba għall-Awtentikazzjoni Standard Mingħajr Tagħbija JSON

Identiku għal 3.1 b'headers relatati mal-kontenut/input hmac barra.
Input HMAC: [request_method]:[request_uri]:[timestamp]:[mhux] input HMAC example: (bl-użu 'algo' bħala ċ-ċavetta sigrieta)
GET:/api/settings/audio.page.vol:1601312252:49936
Iġġenera HMAC b'password u string ta' input HMAC billi tuża SHA-256:
Ħruġ HMAC example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Awtentikazzjoni standard mingħajr payload example:

 Talba għall-Awtentikazzjoni Bażika

Dan il-metodu ta' awtentikazzjoni għandu jintuża b'attenzjoni peress li huwa inqas sigur mill-metodu standard.

Awtorizzazzjoni: Bażiku [base64]
Example:
Awtorizzazzjoni: Bażiku YWRtaW46YWxnbwo=
Awtentikazzjoni bażika example:

KMANDI

 Kmandi tal-API RESTful

Hawn taħt hawn lista tal-kmandi tal-API kollha appoġġjati.

Nota
Talba PUT tinbidel jew toħloq riżors permanenti li jibqa' ħaj minn reboot, filwaqt li talba POST tikkontrolla l-apparat biss għas-sessjoni attwali.

Deskrizzjoni	Metodu	URI	Tagħbija Parametri	Ritorn Example	Prodott	FW
Irkupra l-valur ta 'parametru speċifiku.	IKOLLOK	/api/settings/[key-name] Eż./api/settings/audio.page.vol	N/A	{“audio.page.vol”: “-18dB”}	Kollha	> 3.3
Irritorna l-livell tal-ħoss ambjentali mkejjel f'decibels. Il-Kumpens tal-Ħoss Ambjentali għandu jkun attivat f'Settings Bażiċi -> tab Karatteristiċi.	IKOLLOK	/api/info/audio.noise.level	N/A	{“audio.noise.level”: 72}	Kelliema Uri Kelliema	> 3.3
Oħroġ l-istatus tat-terminal tad-dħul tar-relay.	IKOLLOK	/api/info/input.relay.status	N/A	{“input.relay.status”: “idle”} jew {“input.relay.status”: “attiv”}	Il-prodotti kollha b'input relay, minbarra l-8063. Ara hawn taħt.	> 4.1
Oħroġ l-istatus tat-terminals tal-Input 1 jew tal-Input 2.	IKOLLOK	/api/info/input.relay1.status jew /api/info/input.relay2.status	N/A	{“input.relay1.status”: “idle”} jew {“input.relay1.status”: “attiv”}	8063	> 4.1
Irkupra l-lista tat-ton files bħalissa installati.	IKOLLOK	/api/info/tonelist	N/A	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	Kollha	> 5.0
Irkupra l-informazzjoni tat-tagħmir li tidher fuq il-paġna ta ' l-Istatus.	IKOLLOK	/api/info/status	N/A	Lista sħiħa ta' informazzjoni mit-tab Status.	Kollha	> 5.4

Irkupra l-informazzjoni tal-prodott li tidher fuq il-paġna Dwar.	IKOLLOK	/api/info/about	N/A	L-informazzjoni kollha preżenti fit-tab Dwar.	Kollha	> 5.4
Attiva l-istrobe bil-kulur mixtieq u l-parametri tal-mudell.	POST	/api/controls/strobe/start	mudell: {0 – 15} color1: {blu, aħmar, ambra, aħdar} color2: {blu, aħmar, ambra, aħdar} ledlvl: {1 – 255} holdover: {veru, falz}	N/A	8128(G2) 8138 8190S	> 3.3
Waqqaf l-istrobe.	POST	/api/controls/strobe/stop	N/A	N/A	8128(G2) 8138 8190S	> 3.3
Iddoqq tone darba jew loop it.	POST	/api/kontrolli/ton/bidu	mogħdija: {ton} ie. chime.wav loop: {veru, falz} jew {0, 1} eż. {“path”:”chime.wav”, “loop”:true}	N/A	Kelliema 8301 8373 8028(G2) 8201 8039	> 3.3
Waqqaf it-ton.	POST	/api/kontrolli/ton/stop	N/A	N/A	Kelliema 8301 8373 8028(G2) 8201 8039	> 3.3
Ċempel estensjoni tat-telefon b'messaġġ irreġistrat minn qabel.	POST	/api/controls/call/start	{“estensjoni”:”2099″, “tone”:”gong.wav”, “intervall”:”0″, “maxdur”:”10″}	N/A	Kelliema 8301 8410 8420	> 3.3
Ittemm is-sejħa.	POST	/api/controls/call/stop	N/A	N/A	Kelliema 8301 8410 8420	> 3.3

Ibda sejħa għal paġna one-way. L-apparat se jirċievi l-fluss awdjo mill-estensjoni fil-mira.	POST	/api/controls/call/page	{“estensjoni”:” ”}	N/A	Kelliema 8410 8420	> 5.3.4
Reboot l-endpoint fil-mira.	POST	/api/controls/reboot	N/A	N/A	Kollha	> 3.3
Iftaħ il-bieb. “lokali” tikkontrolla r-relay lokali “netdc1” tikkontrolla l-kontrollur tal-bieb tan-netwerk remot (8063)	POST	/api/kontrolli/bieb/unlock	doorid: {lokali, netdc1} * Mhux obbligatorju	N/A	8039 8028(G2) 8201 8063	> 3.3
Lock il-bieb.	POST	/api/controls/bieb/lock	doorid: {lokali, netdc1} * Mhux obbligatorju	N/A	8039 8028(G2) 8201 8063	> 3.3
Ippermetti r-relay 24v aux out.	POST	api/controls/24v/enable	N/A	N/A	8063	> 5.0
Itfi r-relay 24v aux out.	POST	api/kontrolli/24v/disable	N/A	N/A	8063	> 5.0
Ippermetti l-output relay.	POST	/api/controls/relay/enable	N/A	N/A	8063	> 5.0
Itfi r-relay tal-ħruġ.	POST	/api/controls/relay/disable	N/A	N/A	8063	> 5.0
Iċċekkja s-server tal-firmware ta' Algo għall-aħħar verżjoni tal-firmware.	POST	/api/controls/upgrade/check	N/A	{“verżjoni”: “aġġornata”} jew {“verżjoni”: “ ”}	Kollha	> 4.1
Iċċekkja s-server tal-firmware ta' Algo għall-aħħar verżjoni tal-firmware u aġġorna għal dik il-verżjoni.	POST	/api/controls/upgrade/start	N/A	{“status”: “aġġornat”} jew {“status”: “aġġornament ”, “url”: url>> jew {“status”: “ ”}	Kollha	> 4.1
Uri immaġni jew mudell fuq l-iskrin.	POST	/api/controls/screen/start	Ara hawn taħt	N/A	8410 8420	> 5.3.4
Waqqaf il-mudell tal-iskrin u rritorna għall-iskrin default.	POST	/api/controls/screen/stop	N/A	N/A	8410 8420	> 5.3.4

Ibda mill-ġdid l-applikazzjoni prinċipali.	POST	/api/controls/reload	N/A	N/A	Kollha	> 5.3.4
Ibda tisma 'fluss awdjo dirett. Ikkonfigura n-numru tal-port li għalih qed jintbagħat il-fluss.	POST	/api/controls/rx/start	{“port”: }	N/A	Kollha	> 5.3.4
Tieqaf tisma 'fluss awdjo dirett.	POST	/api/controls/rx/stop	N/A	N/A	Kollha	> 5.3.4
Issettja l-modalità multicast.	POĠĠI	/api/state/mcast/update/	{“mode”:”mittent”, “indirizz”: , “port”: , “tip”:”rtp”} jew {“mod”:”mittent”, “indirizz”: , “port”: , “tip”:”poli”, “grupp”:1} **Nota**: Jekk jintużaw kontrolli/ton/start qabel dan il-kmand, it-ton jindaqq bl-użu tas-settings attwali fuq il- web UI	N/A	8301	> 5.0
Daħħal valur għal parametru speċifiku minn payload JSON.	POĠĠI	/api/settings	parametru: {valur} eż. {“audio.page.vol”: “-3dB”}	N/A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Kmandi ta' Interface ta' Kontroll Sempliċi (SCI).

Il-kmandi SCI kollha huma talbiet GET u għandhom il-parametri komuni "usi" u "admin" għall-awtentikazzjoni.
Example:
IKOLLOK http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Deskrizzjoni	URI	Addizzjonali Tagħbija Parametri	Prodotti	FW
Iftaħ il-bieb. “lokali” tikkontrolla r-relay lokali “netdc1” tikkontrolla l-kontrollur tal-bieb tan-netwerk remot (8063)	/ sci / kontrolli / do jew / nisfruttaw	doorid: {lokali, netdc1} * Mhux obbligatorju	8039 8028(G2) 8201 8063	> 3.3
Lock il-bieb.	/sci/kontrolli/do jew/lock	doorid: {lokali, netdc1} * Mhux obbligatorju	8039 8028(G2) 8201 8063	> 3.3
Iddoqq tone darba jew loop it.	/sci/controls/to ne/bidu	mogħdija: {ton} ie. chime.wav loop: {veru, falz} jew {0, 1}	Kollha	> 3.3
Waqqaf it-ton.	/sci/controls/to ne/stop	N/A	Kollha	> 3.3
Attiva l-istrobe bil-kulur mixtieq u l-parametri tal-mudell.	/sci/kontrolli/strobe/bidu	mudell: {0 – 15} color1: {blu, aħmar, ambra, aħdar} color2: {blu, aħmar, ambra, aħdar} ledlvl: {1 – 255} holdover: {veru, falz}	8128(G2) 8138 8190S	> 3.3
Waqqaf l-istrobe.	/sci/kontrolli/strobe/stop	N/A	8128(G2) 8138 8190S	> 3.3

Dokumenti / Riżorsi

	ALGO RESTful API [pdfGwida għall-Utent AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful API [pdfGwida għall-Utent AL061-GU-CP000API-230717, RESTful API, RESTful, API

Referenzi

• Manwal għall-Utent