ALGO RESTful API

Fampahafantarana momba ny vokatra: RESTful API Guide

Ny Algo RESTful API dia ahafahan'ny mpampiasa miditra, manodinkodina ary manetsika hetsika amin'ny Algo IP Endpoints amin'ny tambajotrany amin'ny alàlan'ny fangatahana HTTP/HTTPS. Ity antontan-taratasy ity dia manome andiana hetsika tsy misy fanjakana sy voafaritra mialoha izay azo ampiasaina hifaneraserana amin'ny fitaovana Algo. Ny API dia manohana ny fangatahana HTTP/HTTPS GET, POST, ary PUT miaraka amin'ny entana JSON.

fanamarinana

Misy karazana fanamarinana telo azo alaina amin'ny Algo RESTful API:

• Fanamarinana manara-penitra (azo atao ny default)
• Fanamarinana fototra (tsy voatery)
• Tsy misy fomba fanamarinana (tsy soso-kevitra; natao fitiliana ihany)

Torolàlana momba ny fampiasana vokatra: RESTful API

zavatra takiana alohan'ny

Alohan'ny hamelana ny RESTful API dia ataovy izay hahazoana antoka fa manana fifandraisana amin'ny Internet ilay fitaovana mba hahatongavana any amin'ireo mpizara NTP efa namboarina mialoha. Raha tsy misy fifandraisana Internet dia amboary ny mpizara NTP eo an-toerana ary ampidiro ny adiresy IP-ny.

Mandeha ny RESTful API

1. Midira ao amin'ny fitaovana web interface tsara ary mandehana mankany amin'ny tabilao Advanced Settings Admin.
2. Mandehana midina mankany amin'ny fizarana API Support ary avelao ny RESTful API.
3. Apetraho ny tenimiafina tianao (tenimiafina default: algo). Mariho fa ny fanamarinana mahazatra dia alefa amin'ny alàlan'ny default.

Mandeha ny fanamarinana fototra (tsy voatery)

1. Ao amin'ny web interface tsara, mandehana mankany amin'ny tabilao System Maintenance ary alaivo ny fanitsiana file.
2. Sokafy ny fikirakirana file miaraka amin'ny mpamoaka lahatsoratra ary ampio ity andalana manaraka ity: api.auth.basic = 1
3. Tehirizo sy ampidiro ny tefy novaina file Miverena any amin'ny fitaovana mampiasa ny Restore Configuration File endri-javatra ao amin'ny tabilao System Maintenance.

Mandeha tsy misy fomba fanamarinana (tsy voatery)

Mba hahafahan'ny fomba tsy misy fanamarinana dia avelao ho banga ny saha RESTful API Password. Ity fomba ity dia tsy soso-kevitra ary tokony hampiasaina amin'ny tanjona fitiliana ihany satria tsy manome fiarovana.

Fampandehanana ny Interface Fanaraha-maso tsotra (tsy voatery)

1. Amin'ny web interface tsara, mandehana mankany amin'ny tabilao System Maintenance ary alaivo ny fanitsiana file.
2. Sokafy ny fikirakirana file mampiasa tonian-dahatsoratra ary ampio andalana roa. Hanova ny tenimiafina tianao.
3. Admin.web.sci = 1
4. Sci.admin.pwd =
5. Tehirizo sy ampidiro ny tefy novaina file Miverena any amin'ny fitaovana mampiasa ny Restore Configuration File endri-javatra ao amin'ny tabilao System Maintenance.

Authentication Sample Fehezan-dalàna

Alefaso azafady support@algosolutions.com raha mila fanamarinana manara-penitra na fototra ianaoample kaody.
Raha mila fanohanana fanampiny dia antsoy 604-454-3792 na mailaka support@algosolutions.com

Fampandrenesana fampahalalana

Fanamarihana
Ny fanamarihana dia manondro fanavaozam-baovao mahasoa, fampahalalana ary torolàlana tokony harahina

Disclaimer

Ny fampahalalana voarakitra ao anatin'ity antontan-taratasy ity dia heverina ho marina amin'ny lafiny rehetra saingy tsy voararan'i Algo. Ny fampahalalana dia azo ovaina tsy misy fampandrenesana ary tsy tokony horaisina amin'ny fomba rehetra ho toy ny fanoloran-tena ataon'ny Algo na ny iray amin'ireo mpiara-miasa aminy na sampana. Algo sy ny mpiara-miasa aminy ary ny sampana dia tsy mandray andraikitra amin'ny hadisoana na tsy fahatomombanana amin'ity antontan-taratasy ity. Ny fanavaozana ity antontan-taratasy ity na ny fanontana vaovao azy dia azo avoaka mba hampidirana ireo fanovana ireo. Algo dia tsy tompon'andraikitra amin'ny fahavoazana na fitakiana vokatry ny fampiasana an'ity boky torolalana ity na vokatra, rindrambaiko, firmware, ary/na fitaovana. Tsy misy ampahany amin'ity antontan-taratasy ity azo averina na ampitaina amin'ny endriny rehetra na amin'ny fomba rehetra - elektronika na mekanika - amin'ny tanjona rehetra raha tsy nahazo alalana an-tsoratra avy amin'i Algo.
Raha mila fanazavana fanampiny na fanampiana ara-teknika any Amerika Avaratra, azafady mifandraisa amin'ny ekipa mpanohana an'i Algo:

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

©2022 Algo dia marika voasoratra anarana an'ny Algo Communication Products Ltd.
Zo rehetra voatokana. Ny marika hafa rehetra dia fananan'ny tompony tsirairay avy. Ny specs rehetra dia mety hiova tsy misy fampandrenesana.

 ANKAPOBENY

Sava lalana

Ity tahirin-kevitra ity dia mamaritra ny fomba azo ampiasana ny Algo RESTful API hidirana, hanodinkodinana ary hanosika hetsika amin'ny Algo IP Endpoints amin'ny tambajotranao amin'ny alàlan'ny fangatahana HTTP/HTTPS, ary koa fomba fanamarinana roa samy hafa miaraka amin'ny ambaratonga fiarovana samihafa. Ny rafitra fangatahana dia afaka mifandray amin'ny fitaovana Algo amin'ny alàlan'ny fanamiana sy voafaritra mialoha ny asa tsy misy fanjakana voafaritra ao amin'ity antontan-taratasy ity. Ny fangatahana dia atao amin'ny URI an'ny loharano miaraka amin'ny entana JSON ary mamoaka valiny JSON. Ny fangatahana HTTP/HTTPS GET, POST, ary PUT dia atao amin'ny loharano URI miaraka amin'ny entana JSON (jereo ny fizarana baiko ho an'ny lisitry ny entana).

 fanamarinana

Misy karazany telo ny authentication:

•  Manara-penitra (recommended)
•  fototra
•  Tsy misy (tsy soso-kevitra)

Ny fanamarinana Standard dia mampiasa Kaody Authentication Hash-based Message Authentication Code (HMAC) miaraka amin'ny digest SHA-256. Ny fanamarinana fototra dia mampiasa kaody Base64 ary tokony hampiasaina amin'ny HTTPS ihany. Tsy misy authentication tokony hampiasaina amin'ny fitandremana fatratra satria tsy manome authentication. Jereo ny fizarana Authentication Requirements raha mila fanazavana fanampiny.

SETUP SY CONFIGURATION

zavatra takiana alohan'ny

•  Ity antontan-taratasy ity dia mihevitra fa ny faran'ny Algo dia mampiasa firmware version 3.3 na ambony.
•  Ny fahasamihafan'ny fotoana eo amin'ny mpangataka sy ny fitaovana Algo dia tokony ho latsaky ny 30 segondra raha hampiasa ny fanamarinana mahazatra.
• Ataovy azo antoka fa ampiasaina ny NTP (Network Time Protocol). Ny adiresin'ny mpizara NTP mahazatra dia azo amboarina ao amin'ny Advanced Settings → Time tab.

Fanamarihana
Ampiantrano ampahibemaso ny lohamilina NTP efa namboarina mialoha, noho izany dia ilaina ny fifandraisana Internet mba hahatongavana any. Raha tsy misy fifandraisana Internet dia amboary ny mpizara NTP eo an-toerana ary ampidiro ny adiresy IP-ny.

• Ataovy azo antoka fa ampifanarahana amin'ny faritry ny fotoana marina ny ora rafitra fitaovana Algo. Azo atao izany amin'ny alàlan'ny fandehanana mankany amin'ny Advanced Settings → Time tab.

 Mandeha ny RESTful API

1. Midira ao amin'ny web interface tsara ary mandehana mankany amin'ny Advanced Settings → Admin tab.
2. Mandehana midina mankany amin'ny fizarana API Support, avelao ny RESTful API ary apetraho ny tenimiafina araka izay irinao (tenimiafina deafault: algo)
   Fanamarihana
   Ny fanamarinana mahazatra dia alefa amin'ny alàlan'ny default.

Alefaso ny fanamarinana fototra (tsy voatery)

1. Ao amin'ny web interface tsara, mandehana mankany amin'ny tabilao System → Maintenance ary alaivo ny fanitsiana file.
2. Sokafy ny fikirakirana file miaraka amin'ny mpamoaka lahatsoratra ary ampio ity andalana manaraka ity: api.auth.basic = 1
3.  Tehirizo sy ampidiro ny tefy novaina file Miverena any amin'ny fitaovana mampiasa ny Restore Configuration File endri-javatra ao amin'ny tabilao System → Maintenance.

Tsy misy fomba fanamarinana (tsy voatery)

Mba hahafahan'ny fomba tsy misy fanamarinana dia avelao ho banga ny saha RESTful API Password. Ity fomba ity dia tsy soso-kevitra ary tokony hampiasaina amin'ny tanjona fitiliana ihany satria tsy manome fiarovana.

Fampandehanana ny Interface Fanaraha-maso tsotra (tsy voatery)

1. Amin'ny web interface tsara, mandehana mankany amin'ny tabilao System → Maintenance ary alaivo ny fanitsiana file.
2.  Sokafy ny fikirakirana file mampiasa tonian-dahatsoratra ary ampio andalana roa. Hanova ny amin'ny tenimiafina tianao. Admin.web.sci = 1
   Sci.admin.pwd =
3.  Tehirizo sy ampidiro ny tefy novaina file Miverena any amin'ny fitaovana mampiasa ny Restore Configuration File endri-javatra ao amin'ny tabilao System → Maintenance.

FILAZANA AZY

Alefaso azafady support@algosolutions.com raha mila fanamarinana manara-penitra na fototra ianaoample kaody.

Fangatahana fanamarinana mahazatra miaraka amin'ny JSON Payload

Lohateny ilaina amin'ny fangatahana HTTP/HTTPS
> Karazana votoaty: "application/json"
> Votoaty-MD5: [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Fanomezana alalana: admin hmac:[tsy]:[hmac_output]
Ny lohatenin'ny fanomezan-dàlana dia ahitana:

1. Ny tady 'hmac admin' arahin'ny colon ':'.
2. Nonce – Sanda kisendrasendra na tsy miverimberina, arahin'ny colon ':'.
3. Hmac_output - novokarin'ny tenimiafina API RESTful (fanalahidy miafina) namboarina tamin'ny fitaovanao sy ny fampidirana HMAC, araka ny etsy ambany:
   [fomba_fangatahana]: [fangatahana_uri]:[votoaty_md5]:[karazana_atiny]:[fotoanaamp]: [tsy]

HMAC input example: (mampiasa 'algo' ho fanalahidy miafina)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Mamorona HMAC miaraka amin'ny tenimiafina sy tady fampidirana HMAC ho digest mampiasa SHA-256:
HMAC Output example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Daty: andro, daty volana, taona ora: min:sec GMT
Example
Daty: Alakamisy, 22 Septambra 2022 02:33:07 GMT
Fanamarinana mahazatra miaraka amin'ny enta-mavesatra example:

 Fangatahana fanamarinana mahazatra tsy misy karama JSON

Mitovy amin'ny 3.1 misy lohapejy mifandraika amin'ny atiny/fampidirana hmac.
Fampidirana HMAC: [fomba_fangatahana]:[fangatahana_uri]:[fotoanaamp]:[tsy] HMAC input example: (mampiasa 'algo' ho fanalahidy miafina)
GET:/api/settings/audio.page.vol:1601312252:49936
Mamorona HMAC miaraka amin'ny tenimiafina sy tady fampidirana HMAC mampiasa SHA-256:
HMAC Output example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Fanamarinana mahazatra tsy misy enta-mavesatra example:

 Fangatahana fanamarinana fototra

Ity fomba fanamarinana ity dia tokony hampiasaina amim-pitandremana satria tsy azo antoka kokoa noho ny fomba mahazatra.

Fanomezana alalana: fototra [base64]
Example:
Fanomezana alalana: Basic YWRtaW46YWxnbwo=
Fanamarinana fototra example:

didy

 Fibaikoana API RESTA

Ity ambany ity ny lisitry ny baiko API rehetra tohana.

Fanamarihana
Ny fangatahana PUT dia manova na mamorona loharano maharitra izay tafavoaka velona amin'ny famerenana indray, raha ny fangatahana POST ihany no mifehy ny fitaovana amin'ny fotoam-pivoriana ankehitriny.

Description	FOMBA	Ory	Payload masontsivana	Miverena Example	vokatra	FW
Alao ny sandan'ny paramètre manokana.	GET	/api/settings/[key-name] Ex./api/settings/audio.page.vol	N / A	{“audio.page.vol”: “-18dB”}	rehetra	> 3.3
Avereno ny haavon'ny tabataba manodidina refesina amin'ny decibel. Tsy maintsy alefa ao amin'ny Settings Basic -> Features tab ny fanonerana ny tabataba manodidina.	GET	/api/info/audio.noise.level	N / A	{“audio.noise.level”: 72}	Mpandahateny mampiseho Mpandahateny	> 3.3
Esory ny satan'ny terminal fampidiran-dresaka.	GET	/api/info/input.relay.status	N / A	{“input.relay.status”: “idle”} na {“input.relay.status”: “active”}	Ny vokatra rehetra misy fampidiran-dresaka, afa-tsy ny 8063. Jereo eto ambany.	> 4.1
Esory ny satan'ny terminal Input 1 na Input 2.	GET	/api/info/input.relay1.status na /api/info/input.relay2.status	N / A	{“input.relay1.status”: “idle”} na {“input.relay1.status”: “active”}	8063	> 4.1
Alao ny lisitry ny tonony files napetraka amin'izao fotoana izao.	GET	/api/info/tonelist	N / A	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	rehetra	> 5.0
Alao ny fampahalalana momba ny fitaovana izay aseho amin'ny pejin'ny Status.	GET	/api/info/status	N / A	Lisitry ny fampahalalana feno avy amin'ny tabilao Status.	rehetra	> 5.4

Alao ny fampahalalana momba ny vokatra izay aseho amin'ny pejy About.	GET	/api/info/about	N / A	Ny fampahalalana rehetra hita ao amin'ny tabilao About.	rehetra	> 5.4
Ampidiro ny strobe miaraka amin'ny masontsivana loko sy lamina tianao.	POST	/api/controls/strobe/start	lamina: {0 – 15} color1: {manga, mena, amber, maitso} color2: {manga, mena, amber, maitso} ledlvl: {1 – 255} fitazonana: {marina, diso}	N / A	8128(G2) 8138 8190S	> 3.3
Atsaharo ny strobe.	POST	/api/controls/strobe/stop	N / A	N / A	8128(G2) 8138 8190S	> 3.3
Alefaso indray mandeha na avereno ilay feo.	POST	/api/controls/tone/start	lalana: {tono} ie. chime.wav loop: {marina, diso} na {0, 1} oh {“lalana”:”chime.wav”, “loop”:true}	N / A	Mpandahateny 8301 8373 8028(G2) 8201 8039	> 3.3
Atsaharo ny tonony.	POST	/api/controls/tone/stop	N / A	N / A	Mpandahateny 8301 8373 8028(G2) 8201 8039	> 3.3
Antsoy ny fanitarana an-telefaona miaraka amin'ny hafatra voarakitra mialoha.	POST	/api/controls/call/start	{“fanitarana”:”2099″, “tone”:”gong.wav”, “interval”:”0″, “maxdur”:”10″}	N / A	Mpandahateny 8301 8410 8420	> 3.3
Tapaho ny antso.	POST	/api/controls/call/stop	N / A	N / A	Mpandahateny 8301 8410 8420	> 3.3

Manomboha antso amin'ny pejy tokana. Hahazo ny feo avy amin'ny fanitarana kendrena ilay fitaovana.	POST	/api/controls/call/page	{"fanitarana":" ”}	N / A	Mpandahateny 8410 8420	> 5.3.4
Avereno indray ny teboka farany kendrena.	POST	/api/controls/reboot	N / A	N / A	rehetra	> 3.3
Sokafy ny varavarana. Ny "local" dia mifehy ny relay eo an-toerana "netdc1" mifehy ny fanaraha-maso ny varavarana tambajotra lavitra (8063)	POST	/api/controls/door/unlock	doorid: {local, netdc1} * Tsy voatery	N / A	8039 8028(G2) 8201 8063	> 3.3
Hidio ny varavarana.	POST	/api/controls/door/lock	doorid: {local, netdc1} * Tsy voatery	N / A	8039 8028(G2) 8201 8063	> 3.3
Alefaso ny relay 24v aux out.	POST	api/controls/24v/enable	N / A	N / A	8063	> 5.0
Atsaharo ny relay 24v aux out.	POST	api/controls/24v/disable	N / A	N / A	8063	> 5.0
Alefaso ny fampitana vokatra.	POST	/api/controls/relay/enable	N / A	N / A	8063	> 5.0
Atsaharo ny fampitana vokatra.	POST	/api/controls/relay/disable	N / A	N / A	8063	> 5.0
Jereo ny mpizara firmware an'i Algo ho an'ny kinova firmware farany.	POST	/api/controls/upgrade/check	N / A	{"version": "nohavaozina"} na {"version": " ”}	rehetra	> 4.1
Hamarino ny mpizara firmware an'i Algo ho an'ny kinova firmware farany ary manavao amin'io dikan-teny io.	POST	/api/controls/upgrade/start	N / A	{“status”: “nohavaozina”} na {“status”: “fanavaozana ”, “url”: url>} na {"status": " ”}	rehetra	> 4.1
Mampisehoa sary na lamina eo amin'ny efijery.	POST	/api/controls/screen/start	JEREO NY ETSY AMBANY	N / A	8410 8420	> 5.3.4
Atsaharo ny lamin'ny efijery ary miverina amin'ny efijery mahazatra.	POST	/api/controls/screen/stop	N / A	N / A	8410 8420	> 5.3.4

Avereno indray ny fampiharana fototra.	POST	/api/controls/reload	N / A	N / A	rehetra	> 5.3.4
Manomboka mihaino onjam-peo mivantana. Ampifanaraho ny laharan'ny seranan-tsambo handefasana ny stream.	POST	/api/controls/rx/start	{"serana": }	N / A	rehetra	> 5.3.4
Atsaharo ny fihainoana onjam-peo mivantana.	POST	/api/controls/rx/stop	N / A	N / A	rehetra	> 5.3.4
Ampidiro ny mode multicast.	ataovy	/api/state/mcast/update/	{“mode”:”mpanefa”, “adiresy”: , "seranan-tsambo": , “karazana”:”rtp”} na {“mode”:”mpanefa”, “adiresy”: , "seranan-tsambo": , “karazana”:”poly”, “vondrona”:1} **Fanamarihana**: Raha ny fanaraha-maso/tononina/manomboka no ampiasaina alohan'ity baiko ity, ny feo dia handeha amin'ny alalan'ny fandrindrana ankehitriny amin'ny web UI.	N / A	8301	> 5.0
Ampidiro sanda amin'ny paramètre manokana avy amin'ny JSON payload.	ataovy	/api/settings	paramètre: {value} oh {“audio.page.vol”: “-3dB”}	N / A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Didy Fanaraha-maso tsotra (SCI).

Ny baiko SCI rehetra dia fangatahana GET ary manana ny mari-pamantarana mahazatra "usi" sy "admin" ho an'ny fanamarinana.
Example:
GET http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Description	Ory	FANAMPINY Payload masontsivana	Products	FW
Sokafy ny varavarana. Ny "local" dia mifehy ny relay eo an-toerana "netdc1" mifehy ny fanaraha-maso ny varavarana tambajotra lavitra (8063)	/sci/controls/do or/unlock	doorid: {local, netdc1} * Tsy voatery	8039 8028(G2) 8201 8063	> 3.3
Hidio ny varavarana.	/sci/controls/do or/lock	doorid: {local, netdc1} * Tsy voatery	8039 8028(G2) 8201 8063	> 3.3
Alefaso indray mandeha na avereno ilay feo.	/sci/controls/to ne/start	lalana: {tono} ie. chime.wav loop: {marina, diso} na {0, 1}	rehetra	> 3.3
Atsaharo ny tonony.	/sci/controls/to ne/stop	N / A	rehetra	> 3.3
Ampidiro ny strobe miaraka amin'ny masontsivana loko sy lamina tianao.	/sci/controls/strobe/start	lamina: {0 – 15} loko1: {manga, mena, amber, maitso} loko2: {manga, mena, amber, maitso} ledlvl: {1 – 255} fitazonana: {marina, diso}	8128(G2) 8138 8190S	> 3.3
Atsaharo ny strobe.	/sci/controls/strobe/stop	N / A	8128(G2) 8138 8190S	> 3.3

Documents / Loharano

	ALGO RESTful API [pdf] Torolàlana ho an'ny mpampiasa AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, API MAMPIDINA, API MAMPIDINA, API
	ALGO RESTful API [pdf] Torolàlana ho an'ny mpampiasa AL061-GU-CP000API-230717, RESTA API, FITSAHARANA, API

References

• User Manual