API ALGO RESTful

Маълумот дар бораи маҳсулот: Дастури RESTful API

API Algo RESTful ба корбарон имкон медиҳад, ки тавассути дархостҳои HTTP/HTTPS амалҳоро дар Algo IP Endpoints дар шабакаи худ дастрас кунанд, идора кунанд ва триггер кунанд. Ин ҳуҷҷат маҷмӯи якхела ва пешакӣ муайяншудаи амалиёти бидуни шаҳрвандӣ, ки метавонанд барои ҳамкорӣ бо дастгоҳҳои Algo истифода шаванд, таъмин менамояд. API дархостҳои HTTP/HTTPS GET, POST ва PUT-ро бо боркунии JSON дастгирӣ мекунад.

Аутентификатсия

Бо Algo RESTful API се намуди аутентификатсия мавҷуд аст:

• Аутентификатсияи стандартӣ (бо нобаёнӣ фаъол аст)
• Аутентификатсияи асосӣ (ихтиёрӣ)
• Ягон усули аутентификатсия (тавсия дода намешавад; танҳо барои мақсадҳои санҷиш)

Дастурҳои истифодаи маҳсулот: RESTful API

Шартҳои пешакӣ

Пеш аз фаъол кардани RESTful API, боварӣ ҳосил кунед, ки дастгоҳ пайвасти интернет дорад, то ба серверҳои қаблан танзимшудаи NTP дастрас шавад. Агар пайвасти интернет мавҷуд набошад, сервери маҳаллии NTP-ро танзим кунед ва суроғаи IP-и онро ворид кунед.

Фаъолсозии RESTful API

1. Ба дастгоҳ ворид шавед web интерфейс ва ба ҷадвали Administrator Advanced Settings гузаред.
2. Ба қисмати дастгирии API поён ҳаракат кунед ва RESTful API-ро фаъол созед.
3. Пароли дилхоҳро таъин кунед (пароли пешфарз: algo). Дар хотир доред, ки аутентификатсияи стандартӣ бо нобаёнӣ фаъол аст.

Даргиронидани аутентификатсияи асосӣ (ихтиёрӣ)

1. Дар web интерфейс, ба ҷадвали Нигоҳдории система гузаред ва конфигуратсияро зеркашӣ кунед file.
2. Конфигуратсияро кушоед file бо ягон муҳаррири матн ва сатри зеринро илова кунед: api.auth.basic = 1
3. Конфигуратсияи тағирёфтаро захира кунед ва бор кунед file бо истифода аз Барқарорсозии конфигуратсия ба дастгоҳ баргардед File хусусият дар ҷадвали Нигоҳдории система.

Даргиронидани бе усули аутентификатсия (ихтиёрӣ)

Барои фаъол кардани усули бе аутентификатсия, майдони RESTful API Password-ро холӣ гузоред. Ин усул тавсия дода намешавад ва бояд танҳо барои санҷиш истифода шавад, зеро он амниятро таъмин намекунад.

Даргиронидани интерфейси идоракунии оддӣ (ихтиёрӣ)

1. Дар web интерфейс, ба ҷадвали Нигоҳдории система гузаред ва конфигуратсияро зеркашӣ кунед file.
2. Конфигуратсияро кушоед file бо истифода аз муҳаррири матн ва ду сатр илова кунед. Пароли дилхоҳатонро иваз кунед.
3. Админ.web.sci = 1
4. Sci.admin.pwd =
5. Конфигуратсияи тағирёфтаро захира кунед ва бор кунед file бо истифода аз Барқарорсозии конфигуратсия ба дастгоҳ баргардед File хусусият дар ҷадвали Нигоҳдории система.

Шиносоии Сample Кодекс

Лутфан почтаи электронӣ фиристед support@algosolutions.com агар шумо мехоҳед аутентификатсияи стандартӣ ё асосӣ дошта бошедampрамзи ле.
Барои дастгирии иловагӣ, занг занед 604-454-3792 ё почтаи электронӣ support@algosolutions.com

Огоҳиҳои иттилоотӣ

Шарҳ
Эзоҳ навсозиҳои муфид, маълумот ва дастурҳоро нишон медиҳад, ки бояд риоя шаванд

Радди масъулият

Маълумоте, ки дар ин ҳуҷҷат мавҷуд аст, аз ҳама ҷиҳат дақиқ аст, аммо аз ҷониби Algo кафолат дода намешавад. Маълумот бояд бидуни огоҳӣ тағир дода шавад ва набояд ба ҳеҷ ваҷҳ ҳамчун ӯҳдадориҳои Algo ё ягон филиал ё филиалҳои он тафсир карда шавад. Algo ва филиалҳо ва зерсохторҳои он барои ҳама гуна хатогиҳо ё камбудиҳо дар ин ҳуҷҷат масъулият надоранд. Таҷҳизоти ин ҳуҷҷат ё таҳрири нави он метавонанд барои ворид кардани чунин тағйиротҳо бароварда шаванд. Algo барои хисорот ё даъвоҳое, ки дар натиҷаи ҳама гуна истифодаи ин дастур ё ин гуна маҳсулот, нармафзор, нармафзори миёнаравӣ ва/ё сахтафзор ба амал меоянд, масъулият ба дӯш намегирад. Ҳеҷ як қисми ин ҳуҷҷатро дар ҳама гуна шакл ё бо ягон восита - электронӣ ё механикӣ - бо ягон мақсад бидуни иҷозати хаттии Algo дубора тавлид кардан ё интиқол додан мумкин нест.
Барои маълумоти иловагӣ ё кӯмаки техникӣ дар Амрикои Шимолӣ, лутфан бо дастаи дастгирии Algo тамос гиред:

Дастгирии техникии Algo
1-604-454-3792
support@algosolutions.com

©2022 Algo тамғаи молии ба қайд гирифташудаи Algo Communication Products Ltd мебошад.
Ҳамаи ҳуқуқ маҳфуз аст. Ҳама тамғаҳои молии дигар моликияти соҳибони мувофиқ мебошанд. Ҳама хусусиятҳо бояд бидуни огоҳӣ тағир дода шаванд.

 ГЕНЕРАЛ

Муқаддима

Ин ҳуҷҷат тавсиф мекунад, ки чӣ гуна API-и Algo RESTful метавонад барои дастрасӣ, коркард ва триггер амалҳо дар Algo IP Endpoints дар шабакаи шумо тавассути дархостҳои HTTP/HTTPS ва инчунин якчанд усулҳои гуногуни аутентификатсия бо сатҳҳои гуногуни амният истифода шавад. Системаҳои дархосткунанда метавонанд бо дастгоҳҳои Algo тавассути маҷмӯи ягона ва пешакӣ муайяншудаи амалиёти бидуни шаҳрвандӣ, ки дар ин ҳуҷҷат муайян шудаанд, ҳамкорӣ кунанд. Дархостҳо ба URI-и манбаъ бо бори JSON дода мешаванд ва посухи JSON-ро ба даст меоранд. Дархостҳои HTTP/HTTPS GET, POST ва PUT ба манбаи URI дар якҷоягӣ бо сарбории JSON дода мешаванд (барои рӯйхати боргузориҳо ба бахши фармонҳо нигаред).

 Аутентификатсия

Се намуди аутентификатсия вуҷуд дорад:

•  Стандарт (тавсия дода мешавад)
•  Асосӣ
•  Ҳеҷ (тавсия дода намешавад)

Аутентификатсияи стандартӣ рамзи аутентификатсияи паёмҳои Hash (HMAC)-ро бо дайджести рамзгузоришудаи SHA-256 истифода мебарад. Аутентификатсияи асосӣ рамзгузории Base64-ро истифода мебарад ва бояд танҳо тавассути HTTPS истифода шавад. Ҳеҷ гуна аутентификатсия набояд танҳо бо эҳтиёти шадид истифода шавад, зеро он аутентификатсияро надорад. Барои тафсилоти бештар ба бахши Талаботи аутентификатсия нигаред.

НАЗОР ВА ТОНФИГУРАЦИЯ

Шартҳои пешакӣ

•  Ин ҳуҷҷат тахмин мекунад, ки нуқтаи ниҳоии Algo версияи нармафзори 3.3 ё навтарро иҷро мекунад.
•  Фарқи вақти байни дархосткунанда ва дастгоҳҳои Algo барои истифодаи аутентификатсияи стандартӣ бояд камтар аз 30 сония бошад.
• Боварӣ ҳосил кунед, ки NTP (Protocol Time Network) дар истифода аст. Суроғаҳои серверҳои фармоишии NTP метавонанд дар ҷадвали Танзимоти пешрафта → Вақт танзим карда шаванд.

Шарҳ
Серверҳои NTP-и қаблан танзимшуда ба таври оммавӣ ҷойгир карда мешаванд, аз ин рӯ барои дастрасӣ ба он пайвасти интернет лозим аст. Агар пайвасти интернет мавҷуд набошад, сервери маҳаллии NTP-ро танзим кунед ва суроғаи IP-и онро ворид кунед.

• Боварӣ ҳосил кунед, ки вақти системаи дастгоҳи Algo ба минтақаи вақти дуруст мувофиқ карда шудааст. Инро метавон тавассути гузариш ба ҷадвали Танзимоти пешрафта → Вақт анҷом дод.

 Фаъолсозии RESTful API

1. Воридшавӣ ба web интерфейс ва ба ҷадвали Танзимотҳои пешрафта → Admin гузаред.
2. Ба қисмати дастгирии API ба поён ҳаракат кунед, RESTful API-ро фаъол созед ва Паролро мувофиқи дилхоҳ таъин кунед (пароли пешфарз: algo)
   Шарҳ
   Аутентификатсияи стандартӣ бо нобаёнӣ фаъол аст.

Тасдиқи асосиро фаъол созед (ихтиёрӣ)

1. Дар web интерфейс, ба ҷадвали Система → Нигоҳдорӣ гузаред ва конфигуратсияро зеркашӣ кунед file.
2. Конфигуратсияро кушоед file бо ягон муҳаррири матн ва сатри зеринро илова кунед: api.auth.basic = 1
3.  Конфигуратсияи тағирёфтаро захира кунед ва бор кунед file бо истифода аз Барқарорсозии конфигуратсия ба дастгоҳ баргардед File хусусият дар ҷадвали Система → Нигоҳдорӣ.

Усули аутентификатсия нест (ихтиёрӣ)

Барои фаъол кардани усули бе аутентификатсия, майдони RESTful API Password-ро холӣ гузоред. Ин усул тавсия дода намешавад ва бояд танҳо барои санҷиш истифода шавад, зеро он амниятро таъмин намекунад.

Даргиронидани интерфейси идоракунии оддӣ (ихтиёрӣ)

1. Дар web интерфейс, ба ҷадвали Система → Нигоҳдорӣ гузаред ва конфигуратсияро зеркашӣ кунед file.
2.  Конфигуратсияро кушоед file бо истифода аз муҳаррири матн ва ду сатр илова кунед. -ро иваз кунед ба пароли хоҳиши худ. Админ.web.sci = 1
   Sci.admin.pwd =
3.  Конфигуратсияи тағирёфтаро захира кунед ва бор кунед file бо истифода аз Барқарорсозии конфигуратсия ба дастгоҳ баргардед File хусусият дар ҷадвали Система → Нигоҳдорӣ.

ТАЛАБОТИ АСОСӢ

Лутфан почтаи электронӣ фиристед support@algosolutions.com агар шумо мехоҳед аутентификатсияи стандартӣ ё асосӣ дошта бошедampрамзи ле.

Дархости стандартии аутентификатсия бо бори JSON

Сарлавҳаҳои зарурӣ дар дархости HTTP/HTTPS
> Навъи мундариҷа: "application/json"
> Content-MD5: [content_md5] Мисолample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Авторизатсия: hmac admin:[nonce]:[hmac_output]
Сарлавҳаҳои иҷозат аз инҳо иборатанд:

1. Сатри 'hmac admin' ва пас аз он ду нуқтаи ':'.
2. Nonce - Қимати тасодуфӣ ё такрорнашаванда, ки пас аз он ду нуқтаи ':' гузошта мешавад.
3. Hmac_output – аз ҷониби Рамзи RESTful API (калиди махфӣ), ки дар дастгоҳи шумо ва вуруди HMAC танзим шудааст, мувофиқи дар зер сохта шудааст:
   [request_method]:[request_uri]:[content_md5]:[навъи_мазмун]:[вақтиamp]:[нест]

Вуруди HMAC, масаланample: (бо истифода аз 'algo' ҳамчун калиди махфӣ)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Эҷоди HMAC бо парол ва сатри вуруди HMAC ҳамчун дайджест бо истифода аз SHA-256:
баромади HMAC, масаланample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Сана: рӯз, моҳ сана, сол соат: дақ: сония GMT
Example
Сана: Панҷшанбе, 22 сентябри 2022, 02:33:07 GMT
Аутентификатсияи стандартӣ бо боркунии боркаш, собиқampле:

 Дархости стандартии тасдиқи бе бори JSON

Бо 3.1 якхела бо сарлавҳаҳои марбут ба мундариҷа/вазиши hmac хориҷ карда шудааст.
Вуруди HMAC: [request_method]: [request_uri]: [вақтamp]:[нест] Вуруди HMAC собиқample: (бо истифода аз 'algo' ҳамчун калиди махфӣ)
GET:/api/settings/audio.page.vol:1601312252:49936
Эҷоди HMAC бо парол ва сатри вуруди HMAC бо истифода аз SHA-256:
баромади HMAC, масаланample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Аутентификатсияи стандартӣ бе боркунии боркаш, собиқampле:

 Дархости аслӣ барои тасдиқ

Ин усули аутентификатсия бояд бо эҳтиёт истифода шавад, зеро он нисбат ба усули стандартӣ камтар бехатар аст.

Авторизатсия: Basic [base64]
Exampле:
Авторизатсия: Basic YWRtaW46YWxnbwo =
Аутентификатсияи асосӣ, масаланampле:

ФАРМОНХО

 Фармонҳои RESTful API

Дар зер рӯйхати ҳамаи фармонҳои API дастгирӣ карда мешавад.

Шарҳ
Дархости PUT манбаи доимиро тағир медиҳад ё эҷод мекунад, ки пас аз бозсозӣ зинда мемонад, дар ҳоле ки дархости POST танҳо дастгоҳро барои сессияи ҷорӣ назорат мекунад.

Тавсифи	Усул	URI	Сарбори Параметрҳо	Бозгашт Example	Маҳсулот	FW
Гирифтани арзиши параметри мушаххас.	ГИРЕД	/api/settings/[калид-ном] Мисол./api/settings/audio.page.vol	Н/А	{"audio.page.vol": "-18dB"}	Ҳама	> 3.3
Сатҳи садои муҳити атрофро, ки бо децибелҳо чен карда шудааст, баргардонед. Ҷуброни садои муҳити атроф бояд дар Танзимоти асосӣ -> ҷадвали Хусусиятҳо фаъол карда шавад.	ГИРЕД	/api/info/audio.noise.level	Н/А	{"audio.noise.level": 72}	Баландгӯякҳо Намоиши баландгӯякҳо	> 3.3
Ҳолати терминали вуруди релеро хориҷ кунед.	ГИРЕД	/api/info/input.relay.status	Н/А	{“input.relay.status”: “bekor”} ё {“input.relay.status”: “фаъол”}	Ҳама маҳсулот бо вуруди реле, ба истиснои 8063. Ба поён нигаред.	> 4.1
Ҳолати терминалҳои Вуруди 1 ё Вуруди 2-ро хориҷ кунед.	ГИРЕД	/api/info/input.relay1.status ё /api/info/input.relay2.status	Н/А	{“input.relay1.status”: “bekor”} ё {“input.relay1.status”: “фаъол”}	8063	> 4.1
Рӯйхати оҳангро дарёфт кунед fileдар айни замон насб карда шудааст.	ГИРЕД	/api/info/tonelist	Н/А	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	Ҳама	> 5.0
Маълумоти дастгоҳро, ки дар саҳифаи Ҳолат нишон дода шудааст, дарёфт кунед.	ГИРЕД	/api/info/status	Н/А	Рӯйхати пурраи маълумот аз ҷадвали Статус.	Ҳама	> 5.4

Маълумоти маҳсулотро, ки дар саҳифаи Дар бораи маҳсулот нишон дода шудааст, дарёфт кунед.	ГИРЕД	/api/info/about	Н/А	Ҳамаи маълумот дар ҷадвали Дар бораи мавҷуд аст.	Ҳама	> 5.4
Стробро бо параметрҳои ранг ва намунаи дилхоҳ фаъол созед.	ПОСТ	/api/controls/strobe/start	намуна: {0 – 15} ранг1: {кабуд, сурх, каҳрабо, сабз} ранг2: {кабуд, сурх, каҳрабо, сабз} ledlvl: {1 – 255} нигоҳдорӣ: {ҳақиқӣ, бардурӯғ}	Н/А	8128 (G2) 8138 8190С	> 3.3
Стробро бас кунед.	ПОСТ	/api/controls/strobe/stop	Н/А	Н/А	8128 (G2) 8138 8190С	> 3.3
Як бор оҳангро навохтан ё онро давр занед.	ПОСТ	/api/controls/tone/start	роҳ: {оҳанг} яъне. chime.wav давра: {true, false} ё {0, 1} масалан, {“роҳ”:”chime.wav”, “халқа”:true}	Н/А	Маърузачиён 8301 8373 8028 (G2) 8201 8039	> 3.3
Оҳангро қатъ кунед.	ПОСТ	/api/controls/tone/stop	Н/А	Н/А	Маърузачиён 8301 8373 8028 (G2) 8201 8039	> 3.3
Ба васеъкунии телефон бо паёми қаблан сабтшуда занг занед.	ПОСТ	/api/controls/call/start	{“extension”:”2099″, “tone”:”gong.wav”, “interval”:”0″, “maxdur”:”10″}	Н/А	Маърузачиён 8301 8410 8420	> 3.3
Зангро хотима диҳед.	ПОСТ	/api/controls/cang/stop	Н/А	Н/А	Маърузачиён 8301 8410 8420	> 3.3

Оғози занги саҳифаи яктарафа. Дастгоҳ ҷараёни аудиоро аз васеъшавии ҳадаф қабул мекунад.	ПОСТ	/api/controls/call/page	{"васеъ":" ”}	Н/А	Маърузачиён 8410 8420	> 5.3.4
Нуқтаи ниҳоии ҳадафро аз нав оғоз кунед.	ПОСТ	/api/controls/reboot	Н/А	Н/А	Ҳама	> 3.3
Дарро кушоед. "Маҳаллӣ" релеи маҳаллиро назорат мекунад "netdc1" контролери дари шабакаи дурдастро назорат мекунад (8063)	ПОСТ	/api/controls/дар/қулф	doorid: {маҳаллӣ, netdc1} * Ихтиёрӣ	Н/А	8039 8028 (G2) 8201 8063	> 3.3
Дарро қулф кунед.	ПОСТ	/api/controls/dar/lock	doorid: {маҳаллӣ, netdc1} * Ихтиёрӣ	Н/А	8039 8028 (G2) 8201 8063	> 3.3
Релеи 24v-ро фаъол созед.	ПОСТ	api/controls/24v/enable	Н/А	Н/А	8063	> 5.0
Релеи 24V-ро хомӯш кунед.	ПОСТ	api/controls/24v/хомӯш кардан	Н/А	Н/А	8063	> 5.0
Релеи баромадро фаъол созед.	ПОСТ	/api/controls/relay/enable	Н/А	Н/А	8063	> 5.0
Релеи баромадро хомӯш кунед.	ПОСТ	/api/controls/relay/хомӯш кардан	Н/А	Н/А	8063	> 5.0
Сервери нармафзори Algo-ро барои версияи охирини нармафзор санҷед.	ПОСТ	/api/controls/upgrade/check	Н/А	{"версия": "навсозӣ"} ё {"версия": " ”}	Ҳама	> 4.1
Сервери нармафзори Algo-ро барои версияи охирини нармафзор санҷед ва ба он версия навсозӣ кунед.	ПОСТ	/api/controls/upgrade/start	Н/А	{"статус": "навсозӣ"} ё {"status": "навсозӣ ”, “url”: url>} ё {"status": " ”}	Ҳама	> 4.1
Дар экран тасвир ё намуна нишон диҳед.	ПОСТ	/api/controls/screen/start	Бинед дар зер	Н/А	8410 8420	> 5.3.4
Намунаи экранро қатъ кунед ва ба экрани пешфарз баргардед.	ПОСТ	/api/controls/screen/stop	Н/А	Н/А	8410 8420	> 5.3.4

Барномаи асосиро аз нав оғоз кунед.	ПОСТ	/api/controls/reload	Н/А	Н/А	Ҳама	> 5.3.4
Ба гӯш кардани ҷараёни мустақими аудио шурӯъ кунед. Рақами портеро, ки ҷараён ба он фиристода мешавад, танзим кунед.	ПОСТ	/api/controls/rx/start	{"порт": }	Н/А	Ҳама	> 5.3.4
Гӯш кардани ҷараёни мустақими аудиоро бас кунед.	ПОСТ	/api/controls/rx/stop	Н/А	Н/А	Ҳама	> 5.3.4
Ҳолати чандрасонаӣ таъин кунед.	ГУЗАРЕД	/api/state/mcast/update/	{"режим":"фиристанда", "суроға": , "порт": , "type":"rtp"} ё {"rejim":"фиристанда", "адрес": , "порт": , "намуд":"поли", "гурӯҳ":1} **Эзоҳ**: Агар пеш аз ин фармон идоракунӣ/оҳанг/оғоз истифода шавад, оҳанг бо истифода аз танзимоти ҷорӣ дар web UI.	Н/А	8301	> 5.0
Ба параметри мушаххас аз бори JSON арзиш ворид кунед.	ГУЗАРЕД	/api/settings	параметр: {арзиш} масалан {“audio.page.vol”: “-3dB”}	Н/А	8180 (G2) 8186 8190 8190С 8301 8373	> 3.3

 Фармонҳои интерфейси оддӣ (SCI).

Ҳама фармонҳои SCI дархостҳои GET мебошанд ва дорои параметрҳои умумии "usi" ва "admin" барои аутентификатсия мебошанд.
Exampле:
Гирифтани http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Тавсифи	URI	Илова Сарбори Параметрҳо	Маҳсулот	FW
Дарро кушоед. "Маҳаллӣ" релеи маҳаллиро назорат мекунад "netdc1" контролери дари шабакаи дурдастро идора мекунад (8063)	/sci/controls/кор ё/қуфл	doorid: {маҳаллӣ, netdc1} * Ихтиёрӣ	8039 8028 (G2) 8201 8063	> 3.3
Дарро қулф кунед.	/sci/controls/do or/lock	doorid: {маҳаллӣ, netdc1} * Ихтиёрӣ	8039 8028 (G2) 8201 8063	> 3.3
Як бор оҳангро навохтан ё онро давр занед.	/sci/controls/ба не/оғоз	роҳ: {оҳанг} яъне. chime.wav давра: {true, false} ё {0, 1}	Ҳама	> 3.3
Оҳангро қатъ кунед.	/sci/controls/to ne/stop	Н/А	Ҳама	> 3.3
Стробро бо параметрҳои ранг ва намунаи дилхоҳ фаъол созед.	/sci/controls/strobe/start	намуна: {0 – 15} ранг1: {кабуд, сурх, каҳрабо, сабз} ранги 2: {кабуд, сурх, каҳрабо, сабз} ledlvl: {1 - 255} нигоҳдорӣ: {ҳақиқӣ, бардурӯғ}	8128 (G2) 8138 8190С	> 3.3
Стробро бас кунед.	/sci/controls/strobe/stop	Н/А	8128 (G2) 8138 8190С	> 3.3

Ҳуҷҷатҳо / Сарчашмаҳо

	API ALGO RESTful [pdf] Дастури корбар AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, API RESTful, RESTful, API
	API ALGO RESTful [pdf] Дастури корбар AL061-GU-CP000API-230717, API RESTful, RESTful, API

Иқтибосҳо

• Дастури корбар