ALGO RESTful API
නිෂ්පාදන තොරතුරු: RESTful API මාර්ගෝපදේශය
Algo RESTful API පරිශීලකයින්ට HTTP/HTTPS ඉල්ලීම් හරහා ඔවුන්ගේ ජාලයේ Algo IP Endpoints වෙත ප්‍රවේශ වීමට, හැසිරවීමට සහ ක්‍රියා කිරීමට ඉඩ සලසයි. මෙම ලේඛනය Algo උපාංග සමඟ අන්තර් ක්‍රියා කිරීමට භාවිතා කළ හැකි ඒකාකාර සහ පූර්ව නිශ්චිත රාජ්‍ය රහිත මෙහෙයුම් කට්ටලයක් සපයයි. API JSON ගෙවීම් සමඟ HTTP/HTTPS GET, POST සහ PUT ඉල්ලීම් සඳහා සහය දක්වයි.
සත්යාපනය
Algo RESTful API සමඟින් සත්යාපනය වර්ග තුනක් තිබේ:
- සම්මත සත්යාපනය (පෙරනිමියෙන් සක්‍රීය කර ඇත)
- මූලික සත්යාපනය (විකල්ප)
- සත්‍යාපන ක්‍රමයක් නොමැත (නිර්දේශිත නොවේ; පරීක්ෂණ අරමුණු සඳහා පමණි)
නිෂ්පාදන භාවිත උපදෙස්: RESTful API
පූර්වාවශ්යතාවයන්
RESTful API සබල කිරීමට පෙර, පෙර-වින්‍යාසගත NTP සේවාදායකයන් වෙත ළඟා වීමට උපාංගයට අන්තර්ජාල සම්බන්ධතාවයක් ඇති බව සහතික කර ගන්න. අන්තර්ජාල සම්බන්ධතාවයක් නොමැති නම්, දේශීය NTP සේවාදායකයක් වින්‍යාස කර එහි IP ලිපිනය ඇතුළත් කරන්න.
RESTful API සබල කරමින්
- උපාංගයට ලොග් වන්න web අතුරු මුහුණත සහ උසස් සැකසුම් පරිපාලක පටිත්ත වෙත යන්න.
- API සහාය කොටස වෙත පහළට අනුචලනය කර RESTful API සබල කරන්න.
- අපේක්ෂිත මුරපදය සකසන්න (පෙරනිමි මුරපදය: ඇල්ගෝ). සම්මත සත්යාපනය පෙරනිමියෙන් සක්‍රීය කර ඇති බව සලකන්න.
මූලික සත්යාපනය සබල කිරීම (විකල්ප)
- දී web අතුරු මුහුණත, පද්ධති නඩත්තු පටිත්ත වෙත ගොස් වින්‍යාසය බාගන්න file.
- වින්‍යාසය විවෘත කරන්න file ඕනෑම පෙළ සංස්කාරකයක් සමඟ පහත පේළිය එක් කරන්න: api.auth.basic = 1
- වෙනස් කළ වින්‍යාසය සුරකින්න සහ උඩුගත කරන්න file Restore Configuration භාවිතයෙන් උපාංගය වෙත ආපසු යන්න File පද්ධති නඩත්තු පටිත්තෙහි විශේෂාංගය.
සත්‍යාපන ක්‍රමයක් සබල කිරීම (විකල්ප)
සත්යාපනය නොමැති ක්රමය සබල කිරීමට, RESTful API මුරපද ක්ෂේත්‍රය හිස්ව තබන්න. මෙම ක්රමය නිර්දේශ කර නොමැති අතර කිසිදු ආරක්ෂාවක් සපයන්නේ නැති බැවින් පරීක්ෂණ අරමුණු සඳහා පමණක් භාවිතා කළ යුතුය.
සරල පාලන අතුරුමුහුණත සබල කිරීම (විකල්ප)
- මත web අතුරු මුහුණත, පද්ධති නඩත්තු පටිත්ත වෙත ගොස් වින්‍යාසය බාගන්න file.
- වින්‍යාසය විවෘත කරන්න file පෙළ සංස්කාරකයක් භාවිතා කර පේළි දෙකක් එක් කරන්න. ඔබගේ අභිමත මුරපදයට වෙනස් කරන්න.
- පරිපාලක.web.sci = 1
- Sci.admin.pwd =
- වෙනස් කළ වින්‍යාසය සුරකින්න සහ උඩුගත කරන්න file Restore Configuration භාවිතයෙන් උපාංගය වෙත ආපසු යන්න File පද්ධති නඩත්තු පටිත්තෙහි විශේෂාංගය.
සත්යාපනය එස්ample කේතය
කරුණාකර ඊමේල් කරන්න support@algosolutions.com ඔබ සම්මත හෝ මූලික සත්‍යාපනයකට කැමති නම් sampලේ කේතය.
අමතර සහාය සඳහා, අමතන්න 604-454-3792 හෝ ඊමේල් support@algosolutions.com
තොරතුරු නිවේදන
සටහන
සටහන ප්‍රයෝජනවත් යාවත්කාලීන කිරීම්, තොරතුරු සහ අනුගමනය කළ යුතු උපදෙස් දක්වයි
වියාචනය
මෙම ලේඛනයේ අඩංගු තොරතුරු සෑම අතින්ම නිවැරදි යැයි විශ්වාස කරන නමුත් ඇල්ගෝ විසින් සහතික නොකෙරේ. තොරතුරු දැනුම්දීමකින් තොරව වෙනස් වීමට යටත් වන අතර Algo හෝ එහි අනුබද්ධිත හෝ අනුබද්ධිත ආයතනයක් විසින් කැපවීමක් ලෙස කිසිදු ආකාරයකින් අර්ථ දැක්විය යුතු නොවේ. Algo සහ එහි අනුබද්ධ සහ අනුබද්ධිත ආයතන මෙම ලේඛනයේ යම් දෝෂ හෝ අතපසුවීම් සඳහා කිසිදු වගකීමක් භාර නොගනී. එවැනි වෙනස්කම් ඇතුළත් කිරීම සඳහා මෙම ලේඛනයේ සංශෝධන හෝ එහි නව සංස්කරණ නිකුත් කළ හැකිය. මෙම අත්පොත හෝ එවැනි නිෂ්පාදන, මෘදුකාංග, ස්ථිරාංග, සහ/හෝ දෘඪාංග භාවිතය නිසා ඇතිවන හානි හෝ හිමිකම් සඳහා ඇල්ගෝ කිසිදු වගකීමක් භාර නොගනී. මෙම ලේඛනයේ කිසිදු කොටසක් ඇල්ගෝ වෙතින් ලිඛිත අවසරයකින් තොරව ඕනෑම අරමුණක් සඳහා ඕනෑම ආකාරයකින් හෝ ඕනෑම ආකාරයකින් - ඉලෙක්ට්‍රොනික හෝ යාන්ත්‍රික - ප්‍රතිනිෂ්පාදනය හෝ සම්ප්‍රේෂණය කළ නොහැක.
උතුරු ඇමරිකාවේ අමතර තොරතුරු හෝ තාක්ෂණික සහාය සඳහා, කරුණාකර Algo හි සහාය කණ්ඩායම අමතන්න:
Algo තාක්ෂණික සහාය
1-604-454-3792
support@algosolutions.com
©2022 Algo යනු Algo Communication Products Ltd හි ලියාපදිංචි වෙළඳ ලකුණකි.
සියලු හිමිකම් ඇවිරිණි. අනෙකුත් සියලුම වෙළඳ ලකුණු ඔවුන්ගේ අයිතිකරුවන්ගේ දේපළ වේ. සියලුම පිරිවිතර දැනුම්දීමකින් තොරව වෙනස් වීමට යටත් වේ.
සාමාන්ය
හැඳින්වීම
HTTP/HTTPS ඉල්ලීම් හරහා ඔබේ ජාලයේ Algo IP Endpoints වෙත ප්‍රවේශ වීමට, හැසිරවීමට සහ ක්‍රියාරම්භ කිරීමට Algo RESTful API භාවිත කළ හැකි ආකාරය මෙම ලේඛනය විස්තර කරයි, මෙන්ම විවිධ මට්ටමේ ආරක්‍ෂක මට්ටම් සහිත විවිධ සත්‍යාපන ක්‍රම කිහිපයක්. ඉල්ලීම් කරන පද්ධති මෙම ලේඛනයේ අර්ථ දක්වා ඇති ඒකාකාර සහ පූර්ව නිර්වචනය කළ අස්ථායී මෙහෙයුම් මාලාවක් හරහා ඇල්ගෝ උපාංග සමඟ අන්තර් ක්‍රියා කළ හැක. JSON ගෙවීමක් සහිත සම්පතක URI වෙත ඉල්ලීම් කරනු ලබන අතර JSON ප්‍රතිචාරයක් ලබා ගනී. HTTP/HTTPS GET, POST, සහ PUT ඉල්ලීම් JSON පේලෝඩ් සමඟ සම්පත් URI සඳහා සිදු කරනු ලැබේ (ගෙවීම් ලැයිස්තුවක් සඳහා විධාන කොටස බලන්න).
සත්යාපනය
සත්යාපනය වර්ග තුනක් ඇත:
- සම්මත (නිර්දේශිත)
- මූලික
- කිසිවක් නැත (නිර්දේශිත නොවේ)
සම්මත සත්යාපනය SHA-256 කේතනය කළ සංග්‍රහයක් සහිත Hash මත පදනම් වූ පණිවිඩ සත්‍යාපන කේතයක් (HMAC) භාවිතා කරයි. මූලික සත්යාපනය Base64 කේතනය භාවිතා කරන අතර භාවිතා කළ යුත්තේ HTTPS හරහා පමණි. කිසිදු සත්‍යාපනයක් භාවිතා නොකළ යුත්තේ එය කිසිදු සත්‍යාපනයක් ලබා නොදෙන බැවින් අතිශය සැලකිල්ලෙන් පමණි. වැඩි විස්තර සඳහා Authentication Requirements කොටස බලන්න.
සැකසුම සහ වින්‍යාසය
පූර්වාවශ්යතාවයන්
- මෙම ලේඛනය Algo අවසන් ලක්ෂ්‍යය ස්ථිරාංග 3.3 හෝ ඊට වැඩි අනුවාදයක් ධාවනය කරන බව උපකල්පනය කරයි.
- සම්මත සත්යාපනය භාවිතා කිරීමට ඉල්ලුම්කරු සහ ඇල්ගෝ උපාංග අතර කාල වෙනස තත්පර 30කට වඩා අඩු විය යුතුය.
- NTP (ජාල කාල ප්‍රොටෝකෝලය) භාවිතයේ පවතින බව සහතික කර ගන්න. අභිරුචි NTP සේවාදායකයන්ගේ ලිපින උසස් සැකසුම් → කාල පටිත්තෙහි වින්‍යාස කළ හැක.
සටහන
පෙර-වින්‍යාස කරන ලද NTP සේවාදායකයන් ප්‍රසිද්ධියේ සත්කාරකත්වය ලබා දී ඇත, එබැවින් එය වෙත ළඟා වීමට අන්තර්ජාල සම්බන්ධතාව අවශ්‍ය වේ. අන්තර්ජාල සම්බන්ධතාවයක් නොමැති නම්, දේශීය NTP සේවාදායකයක් වින්‍යාස කර එහි IP ලිපිනය ඇතුළත් කරන්න.
- Algo උපාංග පද්ධති කාලය නිවැරදි වේලා කලාපයට සකස් කර ඇති බව සහතික කර ගන්න. උසස් සැකසුම් → කාල පටිත්ත වෙත සංචාලනය කිරීමෙන් මෙය කළ හැකිය.
RESTful API සබල කරමින්
- වෙත පිවිසෙන්න web අතුරු මුහුණත සහ උසස් සැකසුම් → පරිපාලක පටිත්ත වෙත යන්න.
- API සහාය කොටස වෙත පහළට අනුචලනය කරන්න, RESTful API සක්‍රීය කර මුරපදය අවශ්‍ය පරිදි සකසන්න (පෙරනිමි මුරපදය: ඇල්ගෝ)
සටහන
සම්මත සත්යාපනය පෙරනිමියෙන් සක්‍රීය කර ඇත.
මූලික සත්යාපනය සබල කරන්න (විකල්ප)
- දී web අතුරු මුහුණත, පද්ධතිය → නඩත්තු පටිත්ත වෙත ගොස් වින්‍යාසය බාගන්න file.
- වින්‍යාසය විවෘත කරන්න file ඕනෑම පෙළ සංස්කාරකයක් සමඟ පහත පේළිය එක් කරන්න: api.auth.basic = 1
- වෙනස් කළ වින්‍යාසය සුරකින්න සහ උඩුගත කරන්න file Restore Configuration භාවිතයෙන් උපාංගය වෙත ආපසු යන්න File පද්ධතිය → නඩත්තු පටිත්තෙහි විශේෂාංගය.
සත්‍යාපන ක්‍රමයක් නැත (විකල්ප)
සත්යාපනය නොමැති ක්රමය සබල කිරීමට, RESTful API මුරපද ක්ෂේත්‍රය හිස්ව තබන්න. මෙම ක්රමය නිර්දේශ කර නොමැති අතර කිසිදු ආරක්ෂාවක් සපයන්නේ නැති බැවින් පරීක්ෂණ අරමුණු සඳහා පමණක් භාවිතා කළ යුතුය.
සරල පාලන අතුරුමුහුණත සබල කිරීම (විකල්ප)
- මත web අතුරු මුහුණත, පද්ධතිය → නඩත්තු පටිත්ත වෙත ගොස් වින්‍යාසය බාගන්න file.
- වින්‍යාසය විවෘත කරන්න file පෙළ සංස්කාරකයක් භාවිතා කර පේළි දෙකක් එක් කරන්න. වෙනස් කරන්න ඔබගේ අභිමත මුරපදයට. පරිපාලක.web.sci = 1
Sci.admin.pwd = - වෙනස් කළ වින්‍යාසය සුරකින්න සහ උඩුගත කරන්න file Restore Configuration භාවිතයෙන් උපාංගය වෙත ආපසු යන්න File පද්ධතිය → නඩත්තු පටිත්තෙහි විශේෂාංගය.
සත්‍යාපන අවශ්‍යතා
කරුණාකර ඊමේල් කරන්න support@algosolutions.com ඔබ සම්මත හෝ මූලික සත්‍යාපනයකට කැමති නම් sampලේ කේතය.
JSON Payload සමඟ සම්මත සත්‍යාපන ඉල්ලීම
HTTP/HTTPS ඉල්ලීමෙහි අවශ්‍ය ශීර්ෂයන්
> අන්තර්ගත වර්ගය: "යෙදුම/json"
> අන්තර්ගතය-MD5: [content_md5] උදාample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b
අවසරය: hmac පරිපාලක:[nonce]:[hmac_output]
අවසර ශීර්ෂයන් සමන්විත වන්නේ:
- 'hmac පරිපාලක' තන්තුවට පසුව ':' තීරුව.
- Nonce – අහඹු හෝ පුනරාවර්තන නොවන අගයක්, පසුව ':' කොලනයක්.
- Hmac_output - ඔබගේ උපාංගයේ වින්‍යාස කර ඇති RESTful API මුරපදය (රහස් යතුර) සහ පහත පරිදි HMAC ආදානය මගින් ජනනය කර ඇත:
[request_method]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[නැත]
HMAC ආදානය example: (රහස් යතුර ලෙස 'ඇල්ගෝ' භාවිතා කිරීම)
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
ගෙවීම් ex සමඟ සම්මත සත්යාපනයampලෙ:
JSON Payload එකක් නොමැතිව සම්මත සත්‍යාපන ඉල්ලීම
අන්තර්ගත සම්බන්ධ ශීර්ෂයන්/hmac ආදානය මඟ හැර ඇති 3.1 ට සමාන වේ.
HMAC ආදානය: [request_method]:[request_uri]:[timestamp]:[nonce] HMAC ආදානය example: (රහස් යතුර ලෙස 'ඇල්ගෝ' භාවිතා කිරීම)
GET:/api/settings/audio.page.vol:1601312252:49936
SHA-256 භාවිතයෙන් මුරපදය සහ HMAC ආදාන තන්තුව සමඟ HMAC ජනනය කරන්න:
HMAC ප්‍රතිදානය උදාample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
ගෙවීමකින් තොරව සම්මත සත්යාපනය exampලෙ:
මූලික සත්‍යාපන ඉල්ලීම
මෙම සත්‍යාපන ක්රමය සාමාන්ය ක්‍රමයට වඩා අඩු ආරක්‍ෂිත බැවින් ප්‍රවේශමෙන් භාවිතා කළ යුතුය.
අවසරය: මූලික [base64]
Exampලෙ:
අවසරය: මූලික YWRtaW46YWxnbwo=
මූලික සත්යාපනය උදාampලෙ:
විධාන
RESTful API විධාන
පහත දැක්වෙන්නේ සහය දක්වන සියලුම API විධාන ලැයිස්තුවකි.
සටහන
PUT ඉල්ලීමක් නැවත පණගැන්වීමකින් නොනැසී පවතින ස්ථිර සම්පතක් වෙනස් කරයි හෝ නිර්මාණය කරයි, POST ඉල්ලීමක් වත්මන් සැසිය සඳහා පමණක් උපාංගය පාලනය කරයි.
| විස්තරය | ක්රමය | URI | ගෙවීම පරාමිතීන් | ආපසු Example | නිෂ්පාදනය | FW |
| නිශ්චිත පරාමිතියක අගය නැවත ලබා ගන්න. | ලබා ගන්න | /api/settings/[key-name] Ex./api/settings/audio.page.vol | N/A | {“audio.page.vol”: “-18dB”} | සියල්ල | > 3.3 |
| ඩෙසිබල් වලින් මනින ලද සංසරණ ශබ්ද මට්ටම නැවත ලබා දෙන්න. මූලික සැකසීම් -> විශේෂාංග ටැබය තුළ අවට ශබ්ද වන්දි ගෙවීම සබල කළ යුතුය. | ලබා ගන්න | /api/info/audio.noise.level | N/A | {“audio.noise.level”: 72} | ස්පීකර් දර්ශන ස්පීකර් | > 3.3 |
| රිලේ ආදාන පර්යන්තයේ තත්ත්වය උපුටා ගන්න. | ලබා ගන්න | /api/info/input.relay.status | N/A |
{“input.relay.status”: “idle”} හෝ {“input.relay.status”: “සක්රිය”} |
8063 හැර රිලේ ආදානය සහිත සියලුම නිෂ්පාදන. පහත බලන්න. | > 4.1 |
| ආදාන 1 හෝ ආදාන 2 පර්යන්තවල තත්ත්වය උපුටා ගන්න. | ලබා ගන්න | /api/info/input.relay1.status හෝ /api/info/input.relay2.status | N/A | {“input.relay1.status”: “idle”} හෝ {“input.relay1.status”: “active”} | 8063 | > 4.1 |
| නාද ලැයිස්තුව ලබා ගන්න fileදැනට ස්ථාපනය කර ඇත. | ලබා ගන්න | /api/info/tonelist |
N/A |
{“ටෝනලිස්ට්”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]} | සියල්ල | > 5.0 |
| තත්ව පිටුවේ පෙන්වන උපාංග තොරතුරු ලබා ගන්න. | ලබා ගන්න | /api/info/status | N/A | තත්ව පටිත්තෙන් සම්පූර්ණ තොරතුරු ලැයිස්තුව. | සියල්ල | > 5.4 |
| ගැන පිටුවේ දර්ශනය වන නිෂ්පාදන තොරතුරු ලබා ගන්න. | ලබා ගන්න | /api/info/about | N/A | සියලුම තොරතුරු About පටිත්තෙහි ඇත. | සියල්ල | > 5.4 |
| අපේක්ෂිත වර්ණ සහ රටා පරාමිතීන් සමඟ ස්ට්රෝබ් සක්රිය කරන්න. | POST | / api/controls/strobe/start | රටාව: {0 – 15} color1: {නිල්, රතු, ඇම්බර්, කොළ} වර්ණ2: {නිල්, රතු, ඇම්බර්, කොළ} ledlvl: {1 – 255} රඳවා තබා ගැනීම: {ඇත්ත, අසත්‍ය} |
N/A | 8128(G2) 8138 8190S |
> 3.3 |
| ස්ට්රෝබ් එක නවත්වන්න. | POST | / api/controls/strobe/stop | N/A | N/A | 8128(G2) 8138 8190S |
> 3.3 |
| ටෝනයක් වරක් වාදනය කරන්න හෝ එය ලූප් කරන්න. | POST | / api/controls/tone/start | මාර්ගය: {tone} එනම්. chime.wav ලූපය: {සත්‍ය, අසත්‍ය} හෝ {0, 1} උදා: {“path”:”chime.wav”, “loop”:true} |
N/A | කථිකයන් 8301 8373 8028(G2) 8201 8039 |
> 3.3 |
| ස්වරය නවත්වන්න. | POST | /api/controls/tone/stop | N/A | N/A | කථිකයන් 8301 8373 8028(G2) 8201 8039 |
> 3.3 |
| කලින් පටිගත කළ පණිවිඩයක් සමඟ දුරකථන දිගුවක් අමතන්න. | POST | / api/controls/call/start | {“දිගුව”:”2099″, “ස්වරය”:”gong.wav”, “අන්තරය”:”0″, “maxdur”:”10″} |
N/A | කථිකයන් 8301 8410 8420 |
> 3.3 |
| ඇමතුම අවසන් කරන්න. | POST | / api/controls/call/stop | N/A | N/A | කථිකයන් 8301 8410 8420 |
> 3.3 |
| එක් පැත්තක පිටු ඇමතුමක් ආරම්භ කරන්න. ඉලක්ක දිගුවෙන් උපාංගයට ශ්‍රව්‍ය ප්‍රවාහය ලැබෙනු ඇත. | POST | /api/controls/call/page | {"දිගුව":" ”} | N/A | කථිකයන් 8410 8420 |
> 5.3.4 |
| ඉලක්ක අවසන් ලක්ෂ්‍යය නැවත ආරම්භ කරන්න. | POST | / api/controls/reboot | N/A | N/A | සියල්ල | > 3.3 |
| දොර අගුළු හරින්න. “දේශීය” දේශීය රිලේ පාලනය කරයි “netdc1” දුරස්ථ ජාල දොර පාලකය පාලනය කරයි (8063) | POST | /api/controls/door/unlock | දොරකඩ: {දේශීය, netdc1} *වෛකල්පිතය |
N/A | 8039 8028(G2) 8201 8063 |
> 3.3 |
| දොර ලොක් කරන්න. | POST | / api/controls/door/lock | දොරකඩ: {දේශීය, netdc1} *වෛකල්පිතය |
N/A | 8039 8028(G2) 8201 8063 |
> 3.3 |
| 24v aux out relay සබල කරන්න. | POST | api/controls/24v/enable කරන්න | N/A | N/A | 8063 | > 5.0 |
| 24v aux out relay අක්රිය කරන්න. | POST | api/controls/24v/disable | N/A | N/A | 8063 | > 5.0 |
| ප්රතිදාන රිලේ සබල කරන්න. | POST | / api/controls/relay/enable | N/A | N/A | 8063 | > 5.0 |
| ප්රතිදාන රිලේ අක්රිය කරන්න. | POST | / api/controls/relay/disable | N/A | N/A | 8063 | > 5.0 |
| නවතම ස්ථිරාංග අනුවාදය සඳහා Algo හි ස්ථිරාංග සේවාදායකය පරීක්ෂා කරන්න. | POST | /api/controls/upgrade/check | N/A | {"අනුවාදය": "යාවත්කාලීන"} හෝ {"අනුවාදය": " ”} |
සියල්ල | > 4.1 |
| නවතම ස්ථිරාංග අනුවාදය සඳහා Algo හි ස්ථිරාංග සේවාදායකය පරීක්ෂා කර එම අනුවාදයට උත්ශ්‍රේණි කරන්න. | POST | / api/controls/upgrade/start | N/A | {“තත්වය”: “යාවත්කාලීන”} හෝ {"තත්ත්වය": "උත්ශ්‍රේණි කිරීම ","url”: url>} හෝ {"තත්වය": " ”} |
සියල්ල | > 4.1 |
| තිරය මත රූපයක් හෝ රටාවක් පෙන්වන්න. | POST | / api/controls/screen/start | බලන්න පහත | N/A | 8410 8420 |
> 5.3.4 |
| තිර රටාව නවත්වා පෙරනිමි තිරය වෙත ආපසු යන්න. | POST | / api/controls/screen/stop | N/A | N/A | 8410 8420 |
> 5.3.4 |
| ප්රධාන යෙදුම නැවත ආරම්භ කරන්න. | POST | /api/controls/reload | N/A | N/A | සියල්ල | > 5.3.4 |
| සෘජු ශ්‍රව්‍ය ප්‍රවාහයකට සවන් දීම ආරම්භ කරන්න. ප්‍රවාහය යවන තොට අංකය වින්‍යාස කරන්න. | POST | / api/controls/rx/start | {“වරාය”: } | N/A | සියල්ල | > 5.3.4 |
| සෘජු ශ්‍රව්‍ය ප්‍රවාහයකට සවන් දීම නවත්වන්න. | POST | / api/controls/rx/stop | N/A | N/A | සියල්ල | > 5.3.4 |
| බහු විකාශන මාදිලිය සකසන්න. | දාන්න | /api/state/mcast/update/ | {"ප්‍රකාරය":"යවන්නා", "ලිපිනය": , "වරාය": , "වර්ගය":"rtp"} හෝ {"ප්‍රකාරය":"යවන්නා", "ලිපිනය": , "වරාය": , "වර්ගය":"පොලි", "කණ්ඩායම":1} **සටහන**: මෙම විධානයට පෙර පාලන/තානය/ආරම්භය භාවිතා කරන්නේ නම්, ටෝනය වත්මන් සිටුවම් භාවිතයෙන් වාදනය වේ. web යූ.අයි. |
N/A | 8301 | > 5.0 |
| JSON payload වෙතින් නිශ්චිත පරාමිතියකට අගයක් ඇතුළු කරන්න. | දාන්න | / api / සැකසුම් | පරාමිතිය: {value} උදා: {“audio.page.vol”: “-3dB”} |
N/A | 8180(G2) 8186 8190 8190S 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) |
/විද්‍යා/පාලන/කරන්න හෝ/අගුළු ඇරීමට | දොරකඩ: {දේශීය, netdc1} *වෛකල්පිතය |
8039 8028(G2) 8201 8063 |
> 3.3 |
| දොර ලොක් කරන්න. | /විද්‍යා/පාලන/කරන්න හෝ/අගුලු දමන්න | දොරකඩ: {දේශීය, netdc1} *වෛකල්පිතය |
8039 8028(G2) 8201 8063 |
> 3.3 |
| ටෝනයක් වරක් වාදනය කරන්න හෝ එය ලූප් කරන්න. | /විද්‍යා/පාලන/නැත/ආරම්භ කිරීමට | මාර්ගය: {tone} එනම්. chime.wav ලූපය: {සත්‍ය, අසත්‍ය} හෝ {0, 1} |
සියල්ල | > 3.3 |
| ස්වරය නවත්වන්න. | /විද්‍යා/පාලන/නො/නැවතීමට | N/A | සියල්ල | > 3.3 |
| අපේක්ෂිත වර්ණ සහ රටා පරාමිතීන් සමඟ ස්ට්රෝබ් සක්රිය කරන්න. | /විද්‍යා/පාලන/ස්ට්රෝබ්/ආරම්භය | රටාව: {0 - 15} වර්ණ1: {නිල්, රතු, ඇම්බර්, කොළ} වර්ණ2: {නිල්, රතු, ඇම්බර්, කොළ} ledlvl: {1 – 255} රඳවා තබා ගැනීම: {සත්‍ය, අසත්‍ය} |
8128(G2) 8138 8190S |
> 3.3 |
| ස්ට්රෝබ් එක නවත්වන්න. | /විද්‍යා/පාලන/ස්ට්රෝබ්/නැවතුම් | N/A | 8128(G2) 8138 8190S |
> 3.3 |
ලේඛන / සම්පත්
 |
ALGO RESTful API [pdf] පරිශීලක මාර්ගෝපදේශය AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API |
 |
ALGO RESTful API [pdf] පරිශීලක මාර්ගෝපදේශය AL061-GU-CP000API-230717, RESTful API, RESTful, API |