ALGO RESTful API

Eolas Táirge: Treoir RESTful API

Ligeann API Algo RESTful d’úsáideoirí rochtain a fháil ar Críochphointí Algo IP, iad a ionramháil agus a spreagadh ar a líonra trí iarratais HTTP/HTTPS. Soláthraíonn an doiciméad seo sraith aonfhoirmeach agus réamhshainithe d’oibríochtaí gan stát ar féidir iad a úsáid chun idirghníomhú le gléasanna Algo. Tacaíonn an API le HTTP/HTTPS GET, POST, agus iarratais PUT le hualaí pála JSON.

Fíordheimhniú

Tá trí chineál fíordheimhnithe ar fáil leis an Algo RESTful API:

• Fíordheimhniú caighdeánach (cumasaithe de réir réamhshocraithe)
• Fíordheimhniú bunúsach (roghnach)
• Gan aon mhodh fíordheimhnithe (ní mholtar; chun críocha tástála amháin)

Treoracha Úsáide Táirge: RESTful API

Réamhriachtanais

Sula gcuirfidh tú an API RESTful ar chumas, cinntigh go bhfuil nasc idirlín ag an bhfeiste chun na freastalaithe NTP réamh-chumraithe a bhaint amach. Mura bhfuil nasc idirlín ar fáil, cumraigh freastalaí NTP áitiúil agus cuir isteach a sheoladh IP.

API RESTful á chumasú

1. Logáil isteach sa gléas web comhéadan agus nascleanúint go dtí an cluaisín Riaracháin Ardsocruithe.
2. Scrollaigh síos go dtí an rannán Tacaíochta API agus cumasaigh an API RESTful.
3. Socraigh an focal faire atá ag teastáil (focal faire réamhshocraithe: algo). Tabhair faoi deara go bhfuil fíordheimhniú caighdeánach cumasaithe de réir réamhshocraithe.

Fíordheimhniú Bunúsach a Chumasú (Roghnach)

1. Sna web comhéadan, nascleanúint chuig an táb Cothabhála Córais agus íoslódáil an chumraíocht file.
2. Oscail an chumraíocht file le heagarthóir téacs ar bith agus cuir an líne seo a leanas leis: api.auth.basic = 1
3. Sábháil agus uaslódáil an chumraíocht leasaithe file ar ais go dtí an gléas ag baint úsáide as an Cumraíocht Athchóirigh File gné sa chluaisín Cothabhála Córais.

Gan Modh Fíordheimhnithe a Chumasú (Roghnach)

Chun an modh gan fíordheimhniú a chumasú, fág an réimse Pasfhocal RESTful API folamh. Ní mholtar an modh seo agus níor cheart é a úsáid ach amháin chun críocha tástála amháin toisc nach soláthraíonn sé aon shlándáil.

Comhéadan Rialaithe Simplí á Chumasú (Roghnach)

1. Ar an web comhéadan, nascleanúint chuig an táb Cothabhála Córais agus íoslódáil an chumraíocht file.
2. Oscail an chumraíocht file ag baint úsáide as eagarthóir téacs agus cuir dhá líne leis. Athraigh an do phasfhocal mhian.
3. Riarachán.web.sci = 1
4. Sci.admin.pwd =
5. Sábháil agus uaslódáil an chumraíocht leasaithe file ar ais go dtí an gléas ag baint úsáide as an Cumraíocht Athchóirigh File gné sa chluaisín Cothabhála Córais.

Fíordheimhniú Sample Cód

Seol ríomhphost le do thoil tacaíocht@algosolutions.com más mian leat fíordheimhniú caighdeánach nó bunúsach sample cód.
Le haghaidh tacaíochta breise, cuir glaoch 604-454-3792 nó ríomhphost tacaíocht@algosolutions.com

Fógraí Faisnéise

Nóta
Léiríonn Nóta nuashonruithe úsáideacha, faisnéis, agus treoracha ba chóir a leanúint

Séanadh

Creidtear go bhfuil an fhaisnéis atá sa doiciméad seo cruinn ar gach slí ach níl sé údar maith ag Algo. Tá an fhaisnéis faoi réir athraithe gan fógra agus níor cheart í a fhorléiriú ar bhealach ar bith mar ghealltanas ó Algo nó aon cheann dá chleamhnaithe nó dá fhochuideachtaí. Ní ghlacann Algo ná a chleamhnaithe ná a fhochuideachtaí freagracht ar bith as aon earráidí nó easnaimh sa doiciméad seo. Féadfar athbhreithnithe ar an doiciméad seo nó eagráin nua de a eisiúint chun athruithe den sórt sin a ionchorprú. Ní ghlacann Algo aon dliteanas i leith damáistí nó éileamh a eascraíonn as aon úsáid a bhaintear as an lámhleabhar seo nó as táirgí, bogearraí, firmware agus/nó crua-earraí dá leithéid. Ní féidir aon chuid den doiciméad seo a atáirgeadh nó a tharchur i bhfoirm ar bith nó ar aon mhodh – leictreonach nó meicniúil – chun críche ar bith gan cead scríofa ó Algo.
Le haghaidh tuilleadh faisnéise nó cúnamh teicniúil i Meiriceá Thuaidh, déan teagmháil le foireann tacaíochta Algo le do thoil:

Tacaíocht Theicniúil Algo
1-604-454-3792
tacaíocht@algosolutions.com

©2022 Is trádmharc cláraithe é Algo de chuid Algo Communication Products Ltd.
Gach ceart ar cosaint. Is maoin dá n-úinéirí faoi seach iad na trádmharcanna eile go léir. Tá gach specs faoi réir athrú gan fógra.

 GINEARÁLTA

Réamhrá

Déanann an doiciméad seo cur síos ar conas is féidir Algo RESTful API a úsáid chun rochtain a fháil ar Críochphointí Algo IP ar do líonra, iad a ionramháil agus a spreagadh trí iarratais HTTP/HTTPS, chomh maith le cúpla modh fíordheimhnithe éagsúla le leibhéil éagsúla slándála. Is féidir le córais iarratais idirghníomhú le gléasanna Algo trí thacar aonfhoirmeach agus réamhshainithe oibríochtaí gan stát a shainítear sa doiciméad seo. Déantar iarratais ar URI acmhainne le pálasta JSON agus faightear freagra JSON. Déantar iarratais HTTP/HTTPS GET, POST, agus PUT chun URI a acmhainniú mar aon le pálasta JSON (féach an rannán orduithe le haghaidh liosta uaslódálacha).

 Fíordheimhniú

Tá trí chineál fíordheimhnithe ann:

•  Caighdeán (molta)
•  Bunúsach
•  Ceann ar bith (ní mholtar)

Úsáideann an fíordheimhniú Caighdeánach Cód Fíordheimhnithe Teachtaireachta Hash-bhunaithe (HMAC) le achoimre ionchódaithe SHA-256. Úsáideann fíordheimhniú bunúsach ionchódú Base64 agus níor cheart é a úsáid ach amháin thar HTTPS. Níor cheart aon fhíordheimhniú a úsáid ach le fíorchúram mar ní sholáthraíonn sé fíordheimhniú. Féach an rannán um Riachtanais Fíordheimhnithe le haghaidh tuilleadh sonraí.

Socrú AGUS Cumraíocht

Réamhriachtanais

•  Glacann an doiciméad seo leis go bhfuil críochphointe Algo ag rith firmware leagan 3.3 nó níos airde.
•  Ba cheart go mbeadh an difríocht ama idir an t-iarratasóir agus na feistí Algo níos lú ná 30 soicind chun fíordheimhniú caighdeánach a úsáid.
• Cinntigh go bhfuil NTP (Network Time Protocol) in úsáid. Féadfar seoltaí freastalaithe NTP saincheaptha a chumrú sa chluaisín Ardsocruithe → Am.

Nóta
Tá na freastalaithe NTP réamhchumraithe á n-óstáil go poiblí, mar sin tá nasc idirlín ag teastáil chun é a bhaint amach. Mura bhfuil nasc idirlín ar fáil, cumraigh freastalaí NTP áitiúil agus cuir isteach a sheoladh IP.

• Cinntigh go ndéantar am córas gléas Algo a choigeartú go dtí an crios ama ceart. Is féidir é seo a dhéanamh trí nascleanúint a dhéanamh chuig an táb Ardsocruithe → Am.

 API RESTful á chumasú

1. Logáil isteach sa web comhéadan agus nascleanúint chuig an Socruithe Casta → Admin tab.
2. Scrollaigh síos go dtí an rannán Tacaíochta API, cumasaigh an API RESTful agus socraigh an Pasfhocal mar is mian leat (pasfhocal réamhshocraithe: algo)
   Nóta
   Tá fíordheimhniú caighdeánach cumasaithe de réir réamhshocraithe.

Cumasaigh Fíordheimhniú Bunúsach (Roghnach)

1. Sna web comhéadan, nascleanúint go dtí an Córas → Cothabháil tab agus íoslódáil an chumraíocht file.
2. Oscail an chumraíocht file le heagarthóir téacs ar bith agus cuir an líne seo a leanas leis: api.auth.basic = 1
3.  Sábháil agus uaslódáil an chumraíocht leasaithe file ar ais go dtí an gléas ag baint úsáide as an Cumraíocht Athchóirigh File gné sa chluaisín Córas → Cothabháil.

Gan Modh Fíordheimhnithe (Roghnach)

Chun an modh gan fíordheimhniú a chumasú, fág an réimse Pasfhocal RESTful API folamh. Ní mholtar an modh seo agus níor cheart é a úsáid ach amháin chun críocha tástála amháin toisc nach soláthraíonn sé aon shlándáil.

Comhéadan Rialaithe Simplí á Chumasú (Roghnach)

1. Ar an web comhéadan, nascleanúint go dtí an Córas → Cothabháil tab agus íoslódáil an chumraíocht file.
2.  Oscail an chumraíocht file ag baint úsáide as eagarthóir téacs agus cuir dhá líne leis. Athraigh an chuig do phasfhocal mhian. Riarachán.web.sci = 1
   Sci.admin.pwd =
3.  Sábháil agus uaslódáil an chumraíocht leasaithe file ar ais go dtí an gléas ag baint úsáide as an Cumraíocht Athchóirigh File gné sa chluaisín Córas → Cothabháil.

CEANGLAIS fhíordheimhnithe

Seol ríomhphost le do thoil tacaíocht@algosolutions.com más mian leat fíordheimhniú caighdeánach nó bunúsach sample cód.

Iarratas Fíordheimhnithe Caighdeánach le hUalach Pála JSON

Ceanntásca riachtanacha san iarratas HTTP/HTTPS
> Cineál Ábhar: “iarratas/json”
> Ábhar-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Údarú: hmac admin:[nonce]:[hmac_output]
Is éard atá sna ceannteidil údaraithe:

1. An teaghrán 'hmac admin' agus idirstad ':' ina dhiaidh.
2. Nonce – Luach randamach nó neamh-athdhéanta, agus idirstad ':' ina dhiaidh.
3. Hmac_output - ginte ag Pasfhocal RESTful API (eochair rúnda) cumraithe ar do ghléas agus ionchur HMAC, mar atá thíos:
   [iarratas_modh]:[iarratas_uri]:[content_md5]:[content_type]:[amamp]:[nua]

Ionchur HMAC example: (ag úsáid 'algo' mar an eochair rúnda)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Gin HMAC le pasfhocal agus sreang ionchuir HMAC mar achoimre ag baint úsáide as SHA-256:
Aschur HMAC example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Dáta: lá, dáta mí, bliain uair: nóim: soicind GMT
Example
Dáta: Déardaoin, 22 Meán Fómhair, 2022 02:33:07 GMT
Fíordheimhniú caighdeánach le pálasta example:

 Iarratas Fíordheimhnithe Caighdeánach Gan Ualach Pála JSON

Mar a chéile le 3.1 agus fágadh ceanntásca a bhaineann le hábhar/ionchur hmac ar lár.
Ionchur HMAC: [iarraidh_modh]:[request_uri]:[am amaamp]:[nimh] ionchur HMAC example: (ag úsáid 'algo' mar an eochair rúnda)
FAIGH:/api/settings/audio.page.vol:1601312252:49936
Gin HMAC le pasfhocal agus teaghrán ionchuir HMAC ag baint úsáide as SHA-256:
Aschur HMAC example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Fíordheimhniú caighdeánach gan pálasta example:

 Iarratas Fíordheimhnithe Bunúsach

Ba cheart an modh fíordheimhnithe seo a úsáid go cúramach mar níl sé chomh slán sin leis an modh caighdeánach.

Údarú: Bunúsach [base64]
Example:
Údarú: Basic YWRtaW46YWxnbwo=
Fíordheimhniú bunúsach example:

ORDUITHE

 Orduithe RESTful API

Anseo thíos tá liosta de na horduithe API go léir a dtacaítear leo.

Nóta
Athraítear nó cruthaíonn iarratas PUT acmhainn bhuan a mhairfidh atosaigh, agus ní rialaíonn iarratas POST ach an gléas don seisiún reatha.

Cur síos	Modh	URI	Ualach pá Paraiméadair	Fill ar ais Example	Táirge	FW
Aisghabh luach paraiméadar ar leith.	FAIGH	/api/settings/[eochairainm] Ex./api/settings/audio.page.vol	N/B	{“audio.page.vol”: “-18dB”}	Gach	>3.3
Tabhair ar ais an leibhéal torainn comhthimpeallach arna thomhas i ndeicibeilí. Ní mór Cúiteamh Torainn Chomhthimpeallaigh a chumasú i cluaisín Socruithe Bunúsacha -> Gnéithe.	FAIGH	/api/info/audio.noise.level	N/B	{"audio.noise.level": 72}	Cainteoirí Taispeáin Cainteoirí	>3.3
Sliocht stádas an teirminéil ionchuir sealaíochta.	FAIGH	/api/info/input.relay.status	N/B	{"input.relay.status": "díomhaoin"} nó {"input.relay.status": "gníomhach"}	Gach táirge a bhfuil ionchur sealaíochta acu, ach amháin an 8063. Féach thíos.	>4.1
Sliocht stádas na gcríochfort Ionchur 1 nó Ionchur 2.	FAIGH	/api/info/input.relay1.status nó /api/info/input.relay2.status	N/B	{"input.relay1.status": "díomhaoin"} nó {"input.relay1.status": "gníomhach"}	8063	>4.1
Aisghabh an liosta toin files suiteáilte faoi láthair.	FAIGH	/api/info/tonelist	N/B	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,” dordánaí.wav”,…]}	Gach	>5.0
Aisghabh an t-eolas gléis atá ar taispeáint ar an leathanach Stádas.	FAIGH	/api/info/status	N/B	Liosta iomlán faisnéise ón gcluaisín Stádas.	Gach	>5.4

Aisghabh an t-eolas táirge atá ar taispeáint ar an leathanach About.	FAIGH	/api/info/faoi	N/B	Gach eolas i láthair ar an About tab.	Gach	>5.4
Gníomhachtaigh an strobe le paraiméadair dath agus patrún atá ag teastáil.	POST	/api/rialuithe/strobe/tús	patrún: {0 – 15} dath 1: {gorm, dearg, ómra, glas} dath2: {gorm, dearg, ómra, glas} ledlvl: {1 – 255} coinneáil: {fíor, bréagach}	N/B	8128(G2) 8138 8190S	>3.3
Stop an strobe.	POST	/api/rialuithe/strobe/stop	N/B	N/B	8128(G2) 8138 8190S	>3.3
Seinn ton uair amháin nó lúb é.	POST	/api/rialuithe/ton/tús	cosán: {ton} .i. cling.wav lúb: {fíor, bréagach} nó {0, 1} m.sh. { “cosán”: ”chime.wav”, “lúb”: fíor}	N/B	Cainteoirí 8301 8373 8028(G2) 8201 8039	>3.3
Stop an ton.	POST	/api/rialuithe/ton/stad	N/B	N/B	Cainteoirí 8301 8373 8028(G2) 8201 8039	>3.3
Cuir glaoch ar shíneadh gutháin le teachtaireacht réamhthaifeadta.	POST	/api/rialuithe/glao/tús	{"síneadh":"2099", “ton”: “gong.wav”, “eatramh”:”0″, “maxdur”:”10″}	N/B	Cainteoirí 8301 8410 8420	>3.3
Cuir deireadh leis an nglao.	POST	/api/rialuithe/glao/stad	N/B	N/B	Cainteoirí 8301 8410 8420	>3.3

Cuir tús le glao leathanach aontreo. Gheobhaidh an gléas an sruth fuaime ón síneadh sprice.	POST	/api/rialuithe/glao/leathanach	{"síneadh":" ” }	N/B	Cainteoirí 8410 8420	>5.3.4
Atosaigh an críochphointe sprice.	POST	/ api/rialuithe/atosaigh	N/B	N/B	Gach	>3.3
Díghlasáil an doras. rialaíonn “áitiúil” an t-athsheachadán áitiúil rialaíonn “netdc1” an cianrialtán dorais (8063)	POST	/ api / rialuithe / doras / díghlasáil	doorid: {áitiúil, netdc1} * Roghnach	N/B	8039 8028(G2) 8201 8063	>3.3
Cuir glas ar an doras.	POST	/api/rialuithe/doras/glas	doorid: {áitiúil, netdc1} * Roghnach	N/B	8039 8028(G2) 8201 8063	>3.3
Cumasaigh an sealaíocht amach 24v aux.	POST	api/rialuithe/24v/cumasaithe	N/B	N/B	8063	>5.0
Díchumasaigh an sealaíocht amach 24v aux.	POST	api/rialuithe/24v/díchumasaigh	N/B	N/B	8063	>5.0
Cumasaigh an t-aschur sealaíochta.	POST	/api/rialuithe/athsheoladh/cumasaithe	N/B	N/B	8063	>5.0
Díchumasaigh an t-aschur sealaíochta.	POST	/api/rialuithe/seoladh/ díchumasaigh	N/B	N/B	8063	>5.0
Seiceáil freastalaí firmware Algo don leagan firmware is déanaí.	POST	/api/rialuithe/uasghrádú/seiceáil	N/B	{“leagan”: “nuashonraithe”} nó {"leagan": " ” }	Gach	>4.1
Seiceáil freastalaí firmware Algo don leagan firmware is déanaí agus uasghrádaigh go dtí an leagan sin.	POST	/api/rialuithe/uasghrádú/tús	N/B	{"stádas": "nuashonraithe"} nó { “stádas”: “uasghrádú ”, “url”: url>} nó {"stádas": " ” }	Gach	>4.1
Taispeáin íomhá nó patrún ar an scáileán.	POST	/api/rialuithe/scáileán/tús	Féach thíos	N/B	8410 8420	>5.3.4
Stop patrún an scáileáin agus filleadh ar an scáileán réamhshocraithe.	POST	/api/rialuithe/scáileán/stad	N/B	N/B	8410 8420	>5.3.4

Atosaigh an príomhfheidhmchlár.	POST	/ api / rialuithe / athlódáil	N/B	N/B	Gach	>5.3.4
Tosaigh ag éisteacht le sruth fuaime díreach. Cumraigh uimhir an phoirt a bhfuil an sruth á sheoladh chuici.	POST	/api/controls/rx/tús	{"port": }	N/B	Gach	>5.3.4
Stop ag éisteacht le sruth fuaime díreach.	POST	/api/rialuithe/rx/stop	N/B	N/B	Gach	>5.3.4
Socraigh an modh multicast.	CUIR	/api/state/mcast/update/	{“mód”: “seoltóir”, “seoladh”: , “port”: , “cineál”:”rtp”} nó {“mód”: “seoltóir”, “seoladh”: , “port”: , “cineál”: “polai”, “grúpa”:1} **Nóta**: Má úsáidtear rialtáin/ton/tús roimh an ordú seo, seinnfear an ton ag baint úsáid as socruithe reatha ar an web Chomhéadain.	N/B	8301	>5.0
Cuir isteach luach chuig paraiméadar ar leith ó pálasta JSON.	CUIR	/api/socruithe	paraiméadar: {value} m.sh. {“audio.page.vol”: “-3dB”}	N/B	8180(G2) 8186 8190 8190S 8301 8373	>3.3

 Orduithe Chomhéadain Rialaithe Simplí (SCI).

Is iarratais GET iad gach ordú SCI agus tá na paraiméadair choiteanna “USi” agus “admin” le haghaidh fíordheimhnithe acu.
Example:
FAIGH http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=áitiúil

Cur síos	URI	Breise Ualach pá Paraiméadair	Táirgí	FW
Díghlasáil an doras. rialaíonn “áitiúil” an t-athsheachadán áitiúil rialaíonn “netdc1” an cianrialtán dorais (8063)	/sci/rialuithe/déan nó/díghlasáil	doorid: {áitiúil, netdc1} * Roghnach	8039 8028(G2) 8201 8063	>3.3
Cuir glas ar an doras.	/sci/rialuithe/déanamh nó/glas	doorid: {áitiúil, netdc1} * Roghnach	8039 8028(G2) 8201 8063	>3.3
Seinn ton uair amháin nó lúb é.	/sci/rialuithe/go ne/tosú	cosán: {ton} .i. cling.wav lúb: {fíor, bréagach} nó {0, 1}	Gach	>3.3
Stop an ton.	/sci/rialuithe/go ne/stop	N/B	Gach	>3.3
Gníomhachtaigh an strobe le paraiméadair dath agus patrún atá ag teastáil.	/sci/rialuithe/strobe/tús	patrún: {0 – 15} dath 1: {gorm, dearg, ómra, glas} dath2: {gorm, dearg, ómra, glas} ledlvl: {1 - 255} coinneáil: {fíor, bréagach}	8128(G2) 8138 8190S	>3.3
Stop an strobe.	/sci/rialuithe/strobe/stop	N/B	8128(G2) 8138 8190S	>3.3

Doiciméid / Acmhainní

	ALGO RESTful API [pdfTreoir Úsáideora AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	ALGO RESTful API [pdfTreoir Úsáideora AL061-GU-CP000API-230717, RESTful API, RESTful, API

Tagairtí

• Lámhleabhar Úsáideora