ALGO RESTful API

Fa'amatalaga Oloa: RESTful API Guide

O le Algo RESTful API e mafai ai e tagata fa'aoga ona fa'aoga, fa'aogaina, ma fa'aoso gaioiga ile Algo IP Endpoints ile latou feso'otaiga e ala ile HTTP/HTTPS talosaga. O lenei pepa o lo'o tu'uina atu ai se toniga ma fa'ata'ita'i seti o fa'agaioiga e leai ni setete e mafai ona fa'aoga e fegalegaleai ai ma masini Algo. E lagolagoina e le API talosaga HTTP/HTTPS GET, POST, ma PUT ma uta JSON.

Fa'amaoni

E tolu ituaiga o fa'amaoniga e maua ile Algo RESTful API:

• Fa'amaoni masani (fa'aagaioia e ala i le fa'aletonu)
• Fa'amaoniga autu (filifiliga)
• Leai se auala faʻamaonia (e le fautuaina; naʻo faʻamoemoega suʻega)

Fa'atonuga o le Fa'aaogāina o Mea: RESTful API

Mea e mana'omia muamua

A'o le'i fa'agaoioi le RESTful API, ia mautinoa o lo'o i ai se feso'ota'iga i luga ole laiga ole masini e o'o atu ai ile fa'aumau NTP ua uma ona fa'atulagaina. Afai e leai se feso'ota'iga i luga ole laiga, fa'apipi'i se server NTP fa'apitonu'u ma fa'aofi lona tuatusi IP.

Fa'aola le RESTful API

1. Ulufale i totonu ole masini web fa'aoga ma fa'afeiloa'i i le Advanced Settings Admin tab.
2. Fa'asolo i lalo i le vaega API Support ma fa'agaoioi le RESTful API.
3. Seti le upu fa'apolopolo e mana'omia (fa'aoga sese: algo). Manatua o le faʻamaonia masani e mafai ona faʻaogaina.

Fa'agaoioi le Fa'amaoniga Fa'avae (Filifili)

1. I le web fa'aoga, fa'afeiloa'i i le Fa'atonuga Fa'atonu tab ma fa'apipi'i le fa'atulagaga file.
2. Tatala le faʻatulagaina file fa'atasi ai ma so'o se fa'atonu tusitusiga ma fa'aopoopo le laina lea: api.auth.basic = 1
3. Fa'asaoina ma tu'u i luga le fa'atulagaga ua suia file toe foʻi i le masini e faʻaaoga ai le Toe Faʻatonuina File fa'aalia i le fa'ailoga Fa'atonu Fa'atonu.

Fa'aagaoioiga Leai se Fa'amaoniga Metotia (Filifili)

Ina ia fa'aogaina le auala e leai se fa'amaoniga, tu'u le avanoa o le FA'Atumau API Fa'amaufa'ailoga. O lenei metotia e le fautuaina ma e tatau ona faʻaaogaina mo naʻo faʻamoemoega o suʻega ona e leai se puipuiga.

Fa'aagaoioiga Fa'atonu Fa'amatalaga Fa'afaigofie (Filifili)

1. I luga o le web fa'aoga, fa'afeiloa'i i le Fa'atonuga Fa'atonu tab ma fa'apipi'i le fa'atulagaga file.
2. Tatala le faʻatulagaina file fa'aaoga se fa'atonu tusitusiga ma fa'aopoopo laina se lua. Suia le upu faataga i lou manao.
3. Pule.web.sci = 1
4. Sci.admin.pwd =
5. Fa'asaoina ma tu'u i luga le fa'atulagaga ua suia file toe foʻi i le masini e faʻaaoga ai le Toe Faʻatonuina File fa'aalia i le fa'ailoga Fa'atonu Fa'atonu.

Fa'amaoni Sample Tulafono

Fa'amolemole imeli support@algosolutions.com pe afai e te mana'o i se fa'amaoniga masani po'o fa'amautu sample tulafono.
Mo fesoasoani faaopoopo, vala'au 604-454-3792 po'o imeli support@algosolutions.com

Fa'amatalaga Fa'amatalaga

Manatua
Faʻamatalaga e faʻaalia ai faʻamatalaga aoga, faʻamatalaga, ma faʻatonuga e tatau ona mulimulitaʻia

Fa'ailoga

O faʻamatalaga o loʻo i totonu o lenei pepa e talitonuina e saʻo i itu uma ae e le faʻamaonia e Algo. O faʻamatalaga e mafai ona suia e aunoa ma se faʻaaliga ma e le tatau ona faauigaina i soʻo se auala o se tautinoga a Algo poʻo soʻo se tasi o ana paaga poʻo lala. Algo ma ana paaga ma lala e leai se matafaioi mo soʻo se mea sese poʻo le faʻaaogaina i lenei pepa. O toe teuteuga o lenei pepa po'o lomiga fou e mafai ona tu'uina atu e fa'aofi ai ia suiga. Algo e leai se noataga mo mea fa'aleagaina po'o tagi e mafua mai i so'o se fa'aogaina o lenei tusi lesona po'o ia oloa, software, firmware, ma/po'o meafaigaluega. E leai se vaega o lenei pepa e mafai ona toe gaosia pe fa'asalalau i so'o se faiga po'o so'o se auala - fa'aeletoroni po'o masini - mo so'o se fa'amoemoe e aunoa ma se fa'atagaga tusitusia mai Algo.
Mo nisi fa'amatalaga po'o fesoasoani fa'apitoa i Amerika i Matu, fa'amolemole fa'afeso'ota'i le vaega lagolago a Algo:

Algo Technical Support
1-604-454-3792
support@algosolutions.com

©2022 Algo ose fa'ailoga fa'amaufa'ailoga a Algo Communication Products Ltd.
Ua Taofia Aia Tatau Uma. O isi fa'ailoga tau fefa'ataua'iga uma o meatotino a latou tagata e ona. O fa'amatalaga uma e mafai ona suia e aunoa ma se fa'aaliga.

 TALA ATU

Folasaga

O lenei pepa o loʻo faʻamatalaina pe faʻafefea ona faʻaogaina le Algo RESTful API e faʻaoga, faʻaogaina, ma faʻaoso gaioiga i Algo IP Endpoints i luga o lau fesoʻotaʻiga e ala i talosaga HTTP/HTTPS, faʻapea foʻi ma ni auala faʻamaonia eseese e eseese tulaga o le saogalemu. Talosaga faiga e mafai ona fegalegaleai ma Algo masini e ala i se toniga ma fa'ata'ita'i seti o faagaioiga leai se setete o loʻo faʻamatalaina i lenei pepa. O talosaga e faia i le URI a se puna'oa ma se uta JSON ma fa'ailoa mai ai se tali a le JSON. HTTP/HTTPS GET, POST, ma PUT talosaga e faia i punaoa URI faatasi ai ma le uta JSON (silasila i le vaega o poloaiga mo se lisi o totogi).

 Fa'amaoni

E tolu ituaiga o faʻamaoniga:

•  Fa'atonu (fautua)
•  Fa'avae
•  Leai (le fautuaina)

O le faʻamaoniga masani e faʻaaogaina ai le Hash-based Message Authentication Code (HMAC) faʻatasi ai ma le SHA-256 faʻapipiʻi faʻailoga. O fa'amaoniga autu e fa'aoga ai le Base64 encoding ma e tatau ona fa'aoga i luga ole HTTPS. Leai se fa'amaoniga e tatau ona fa'aaogaina ma le fa'aeteete tele aua e leai se fa'amaoniga. Va'ai le vaega Fa'amaonia Manaoga mo nisi fa'amatalaga.

FA'ATUNUU MA FA'ATA'IGA

Mea e mana'omia muamua

•  O lenei pepa o loʻo faʻapea o le Algo endpoint o loʻo faʻaogaina le firmware version 3.3 poʻo le maualuga.
•  Ole eseesega ole taimi ile va ole tagata talosaga ma masini Algo e tatau ona itiiti ifo ile 30 sekone e fa'aoga ai le fa'amaoniga masani.
• Ia mautinoa o loʻo faʻaogaina le NTP (Network Time Protocol). O tuatusi o sapalai masani NTP e mafai ona faʻapipiʻiina i le Advanced Settings → Time tab.

Manatua
O lo'o fa'apipi'iina fa'alaua'itele le 'au'aunaga NTP, o lea e mana'omia ai feso'ota'iga initaneti e o'o atu ai. Afai e leai se feso'ota'iga i luga ole laiga, fa'apipi'i se server NTP fa'apitonu'u ma fa'aofi lona tuatusi IP.

• Ia mautinoa ua fetuutuunai le taimi o le masini Algo i le sone sa'o. E mafai ona faia lenei mea e ala i le suʻeina i le Advanced Settings → Time tab.

 Fa'aola le RESTful API

1. Ulufale i totonu o le web fa'aoga ma fa'afeiloa'i i le Advanced Settings → Admin tab.
2. Fa'asolo i lalo i le vaega o le API Support, fa'agaoioi le RESTful API ma fa'atulaga le Upu e pei ona mana'o ai (fa'aoga sese: algo)
   Manatua
   O le fa'amaoniga masani e mafai ona fa'aletonu.

Fa'agaoioi le Fa'amaoniga Fa'avae (Filifili)

1. I le web atinaʻe, faʻafeiloaʻi i le System → Maintenance tab ma download le faʻatulagaga file.
2. Tatala le faʻatulagaina file fa'atasi ai ma so'o se fa'atonu tusitusiga ma fa'aopoopo le laina lea: api.auth.basic = 1
3.  Fa'asaoina ma tu'u i luga le fa'atulagaga ua suia file toe foʻi i le masini e faʻaaoga ai le Toe Faʻatonuina File fa'aalia i le System → Maintenance tab.

Leai se auala fa'amaonia (filifiliga)

Ina ia fa'aogaina le auala e leai se fa'amaoniga, tu'u le avanoa o le FA'Atumau API Fa'amaufa'ailoga. O lenei metotia e le fautuaina ma e tatau ona faʻaaogaina mo naʻo faʻamoemoega o suʻega ona e leai se puipuiga.

Fa'aagaoioiga Fa'atonu Fa'amatalaga Fa'afaigofie (Filifili)

1. I luga o le web atinaʻe, faʻafeiloaʻi i le System → Maintenance tab ma download le faʻatulagaga file.
2.  Tatala le faʻatulagaina file fa'aaoga se fa'atonu tusitusiga ma fa'aopoopo laina se lua. Suia le i lou manao password. Pule.web.sci = 1
   Sci.admin.pwd =
3.  Fa'asaoina ma tu'u i luga le fa'atulagaga ua suia file toe foʻi i le masini e faʻaaoga ai le Toe Faʻatonuina File fa'aalia i le System → Maintenance tab.

TULAGA FAATUATUA

Fa'amolemole imeli support@algosolutions.com pe afai e te mana'o i se fa'amaoniga masani po'o fa'amautu sample tulafono.

Talosaga Fa'amaoni Fa'ata'ita'i fa'atasi ma se Totogi JSON

Manaomia ulutala ile HTTP/HTTPS talosaga
> Ituaiga-ituaiga: "application/json"
> Anotusi-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Fa'atagaga: hmac admin:[leai]:[hmac_output]
O ulutala faataga e aofia ai:

1. O le manoa 'hmac admin' soso'o ai ma le kolone ':'.
2. Leai – O se tau fa'afuase'i po'o le toe fai, soso'o ai ma le koluma ':'.
3. Hmac_output – fa'atupuina e le RESTful API Password (secret-key) fa'apipi'i i lau masini ma le HMAC input, e pei ona i lalo:
   [metotia_talosaga]:[request_uri]:[content_md5]:[content_type]:[taimiamp]:[leai]

HMAC fa'aoga fa'atasiample: (faʻaaogaina 'algo' e fai ma ki faalilolilo)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Fausia le HMAC ma le password ma le HMAC input string e faʻaaoga ai le SHA-256:
HMAC galuega faatino example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Aso: aso, aso masina, tausaga itula: min:sec GMT
Example
Aso: Aso, 22 Setema, 2022 02:33:07 GMT
Fa'amaoniga masani fa'atasi ma uta utaampLe:

 Talosaga Faʻamaonia Faʻamaonia e aunoa ma se JSON Payload

E tutusa ma le 3.1 fa'atasi ai ma fa'auluuluga e feso'ota'i i mataupu/fa'aoga hmac ua le maua.
Fa'aoga HMAC: [talosaga_metotia]:[talosaga_uri]:[taimiamp]:[leai] fa'aoga HMAC example: (faʻaaogaina 'algo' e fai ma ki faalilolilo)
MAUA:/api/settings/audio.page.vol:1601312252:49936
Fausia le HMAC ma upu fa'aulu ma le HMAC fa'aoga manoa fa'aaoga SHA-256:
HMAC galuega faatino example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Fa'amaoniga masani e aunoa ma se uta utaampLe:

 Talosaga Authentication Autu

O lenei metotia o le faʻamaonia e tatau ona faʻaogaina ma le faʻaeteete aua e itiiti le saogalemu nai lo le auala masani.

Fa'atagaga: Fa'avae [base64]
ExampLe:
Fa'atagaga: Basic YWRtaW46YWxnbwo=
Fa'amaoniga autu exampLe:

POLOAIGA

 Poloaiga API mapu

O lo'o i lalo le lisi o tulafono API uma e lagolagoina.

Manatua
O se talosaga a le PUT e suia pe fatuina se punaoa tumau e sao mai le toe faʻafouina, ae o le POST talosaga naʻo le pulea o le masini mo le taimi nei.

Fa'amatalaga	Metotia	URI	Totogi uta Parameter	Toe fo'i Example	Oloa	FW
Toe aumai le tau o se parakalafa patino.	MAUA	/api/settings/[key-name] Ex./api/settings/audio.page.vol	N/A	{“audio.page.vol”: “-18dB”}	O mea uma	> 3.3
Toe fa'afo'i le maualuga o le pisa o lo'o fuaina ile decibel. Ambient Noise Compensation e tatau ona fa'agaoioia ile Fa'atonu Fa'atonu -> Fa'ailoga Fa'ailoga.	MAUA	/api/info/audio.noise.level	N/A	{“audio.noise.level”: 72}	Fa'aaliga Fa'aali Fofoga Fetalai	> 3.3
Aveese le tulaga o le mea e fa'aoga ai le ta'avale.	MAUA	/api/info/input.relay.status	N/A	{“input.relay.status”: “idle”} po o {“input.relay.status”: “active”}	O oloa uma o lo'o i ai se mea e fa'aoga ai, se'i vagana le 8063. Va'ai i lalo.	> 4.1
Aveese le tulaga o le Input 1 poʻo le Input 2 terminals.	MAUA	/api/info/input.relay1.status poʻo /api/info/input.relay2.status	N/A	{“input.relay1.status”: “idle”} po o le {“input.relay1.status”: “active”}	8063	> 4.1
Toe aumai le lisi o leo files fa'apipi'i nei.	MAUA	/api/info/tonelist	N/A	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	O mea uma	> 5.0
Toe aumai le faʻamatalaga o masini o loʻo faʻaalia i luga ole itulau Tulaga.	MAUA	/api/info/status	N/A	Lisi atoa o fa'amatalaga mai le tulaga tab.	O mea uma	> 5.4

Toe aumai faʻamatalaga o oloa o loʻo faʻaalia i luga o le About page.	MAUA	/api/info/about	N/A	O faʻamatalaga uma o loʻo i luga o le About tab.	O mea uma	> 5.4
Fa'agaoioia le strobe i lanu e mana'omia ma fa'asologa o mamanu.	POST	/api/controls/strobe/start	mamanu: {0 – 15} lanu1: {blue, red, amber, green} color2: {blue, red, amber, green} ledlvl: {1 – 255} taofi: {moni, sese}	N/A	8128(G2) 8138 8190S	> 3.3
Taofi le strobe.	POST	/api/controls/strobe/stop	N/A	N/A	8128(G2) 8138 8190S	> 3.3
Ta'alo se leo e tasi pe fa'ata'amilo.	POST	/api/controls/tone/start	ala: {tone} ie. chime.wav fa'alavelave: {true, false} po'o {0, 1} eg {“path”:”chime.wav”, “loop”:true}	N/A	failauga 8301 8373 8028(G2) 8201 8039	> 3.3
Taofi le leo.	POST	/api/controls/tone/stop	N/A	N/A	failauga 8301 8373 8028(G2) 8201 8039	> 3.3
Valaau se fa'aopoopoga telefoni ma se fe'au na mua'i pu'eina.	POST	/api/controls/call/start	{“faaopoopoga”:”2099″, “leo”:”gong.wav”, “ava”:”0″, “maxdur”:”10″}	N/A	failauga 8301 8410 8420	> 3.3
Faauma le valaau.	POST	/api/controls/call/stop	N/A	N/A	failauga 8301 8410 8420	> 3.3

Amata se itulau e tasi le auala. O le a maua e le masini le vaitafe leo mai le faʻaopoopoga faʻatatau.	POST	/api/controls/call/page	{“faaopoopoga”:” ”}	N/A	failauga 8410 8420	> 5.3.4
Toe fa'afou le pito fa'amoemoe.	POST	/api/controls/reboot	N/A	N/A	O mea uma	> 3.3
Tatala le faitotoa. “Local” e pulea le ta'avale fa'apitonu'u "netdc1" fa'atonutonu le fa'atonu faitoto'a feso'otaiga mamao (8063)	POST	/api/controls/door/unlock	faitotoa: {local, netdc1} * Pule oe pe fai	N/A	8039 8028(G2) 8201 8063	> 3.3
Loka le faitotoa.	POST	/api/controls/door/loka	faitotoa: {local, netdc1} * Pule oe pe fai	N/A	8039 8028(G2) 8201 8063	> 3.3
Fa'aaga le 24v aux out relay.	POST	api/pulea/24v/enable	N/A	N/A	8063	> 5.0
Tape le 24v aux out relay.	POST	api/pulea/24v/disable	N/A	N/A	8063	> 5.0
Fa'aaga le fa'asolo o mea e fai.	POST	/api/controls/relay/enable	N/A	N/A	8063	> 5.0
Ta'e le ta'avale fa'aulu.	POST	/api/controls/relay/disable	N/A	N/A	8063	> 5.0
Siaki le 'au'aunaga firmware a Algo mo le fa'afouga fou firmware.	POST	/api/controls/upgrade/check	N/A	{“version”: “updated”} or {“version”: “ ”}	O mea uma	> 4.1
Siaki le 'au'aunaga firmware a Algo mo le fa'afouga fou o le firmware ma fa'aleleia i lena fa'amatalaga.	POST	/api/controls/upgrade/start	N/A	{“tulaga”: “faafouina”} po o {“tulaga”: “faaleleia ”, “url”: url>} po'o {“tulaga”: “ ”}	O mea uma	> 4.1
Faaali atu se ata po o se mamanu i luga o le lau.	POST	/api/controls/screen/start	Vaai lalo	N/A	8410 8420	> 5.3.4
Taofi le mamanu o le lau ma toe foi i le mata e le masani ai.	POST	/api/controls/screen/stop	N/A	N/A	8410 8420	> 5.3.4

Toe amata le talosaga autu.	POST	/api/controls/reload	N/A	N/A	O mea uma	> 5.3.4
Amata fa'alogo i se fa'alogo leo sa'o. Fa'atulaga le numera o le uafu o lo'o lafo i ai le vaitafe.	POST	/api/controls/rx/start	{“taulaga”: }	N/A	O mea uma	> 5.3.4
Taofi le fa'alogo i se fa'alogo leo sa'o.	POST	/api/controls/rx/stop	N/A	N/A	O mea uma	> 5.3.4
Seti le auala telecast.	TUU	/api/state/mcast/update/	{“mode”:”sender”, “address”: , “taulaga”: , “type”:”rtp”} po o le {“mode”:”sender”, “address”: , “taulaga”: , “type”:”poly”, “group”:1} **Manatua**: Afai e fa'aoga le fa'atonu/leo/amata a'o le'i faia lenei fa'atonuga, o le a ta'alo le leo e fa'aaoga ai tulaga o lo'o iai nei i le web UI.	N/A	8301	> 5.0
Fa'aofi se tau i se parakalafa patino mai le uta JSON.	TUU	/api/settings	parakalafa: {value} eg {“audio.page.vol”: “-3dB”}	N/A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Fa'atonuga Pulea Fa'atonu (SCI).

O tulafono uma a le SCI o GET talosaga ma e iai fa'asologa masani "usi" ma le "admin" mo le fa'amaoni.
ExampLe:
MAUA http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Fa'amatalaga	URI	Faaopoopo Totogi uta Parameter	Oloa	FW
Tatala le faitotoa. “Local” e pulea le relay i le lotoifale “netdc1” e pulea le pule o faitotoa o feso'otaiga mamao (8063)	/sci/controls/do or/unlock	faitotoa: {local, netdc1} * Pule oe pe fai	8039 8028(G2) 8201 8063	> 3.3
Loka le faitotoa.	/sci/controls/do or/loka	faitotoa: {local, netdc1} * Pule oe pe fai	8039 8028(G2) 8201 8063	> 3.3
Ta'alo se leo e tasi pe fa'ata'amilo.	/sci/controls/to ne/amata	ala: {tone} ie. chime.wav fa'alavelave: {true, false} po'o {0, 1}	O mea uma	> 3.3
Taofi le leo.	/sci/controls/to ne/stop	N/A	O mea uma	> 3.3
Fa'agaoioia le strobe i lanu e mana'omia ma fa'asologa o mamanu.	/sci/controls/strobe/start	mamanu: {0 – 15} lanu1: {lanumoana, mumu, amber, lanumeamata} lanu2: {lanumoana, mumu, amber, lanumeamata} ledlvl: {1 – 255} taofi: {moni, sese}	8128(G2) 8138 8190S	> 3.3
Taofi le strobe.	/sci/controls/strobe/stop	N/A	8128(G2) 8138 8190S	> 3.3

Pepa / Punaoa

	ALGO RESTful API [pdf] Taiala mo Tagata Fa'aoga AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, MAFELEI API, MAFELEI, API
	ALGO RESTful API [pdf] Taiala mo Tagata Fa'aoga AL061-GU-CP000API-230717, MAFOTO API, MAFOTO, API

Fa'asinomaga

• Tusi Taiala