ALGO RESTful API

ព័ត៌មានអំពីផលិតផល៖ មគ្គុទ្ទេសក៍ API RESTful

Algo RESTful API អនុញ្ញាតឱ្យអ្នកប្រើប្រាស់ចូលប្រើ រៀបចំ និងចាប់ផ្តើមសកម្មភាពនៅលើ Algo IP Endpoints នៅលើបណ្តាញរបស់ពួកគេតាមរយៈសំណើ HTTP/HTTPS ។ ឯកសារនេះផ្តល់នូវសំណុំឯកសណ្ឋាន និងដែលបានកំណត់ជាមុននៃប្រតិបត្តិការគ្មានរដ្ឋ ដែលអាចត្រូវបានប្រើដើម្បីធ្វើអន្តរកម្មជាមួយឧបករណ៍ Algo ។ API គាំទ្រសំណើ HTTP/HTTPS GET, POST និង PUT ជាមួយនឹង JSON payloads ។

ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ

មានការផ្ទៀងផ្ទាត់បីប្រភេទដែលមានជាមួយ Algo RESTful API៖

• ការផ្ទៀងផ្ទាត់ស្តង់ដារ (ត្រូវបានបើកតាមលំនាំដើម)
• ការផ្ទៀងផ្ទាត់មូលដ្ឋាន (ជាជម្រើស)
• គ្មានវិធីសាស្ត្រផ្ទៀងផ្ទាត់ (មិនត្រូវបានណែនាំទេ សម្រាប់តែគោលបំណងសាកល្បងប៉ុណ្ណោះ)

ការណែនាំអំពីការប្រើប្រាស់ផលិតផល៖ RESTful API

តម្រូវការជាមុន

មុនពេលបើកដំណើរការ RESTful API សូមប្រាកដថាឧបករណ៍មានការតភ្ជាប់អ៊ីនធឺណិតដើម្បីទៅដល់ម៉ាស៊ីនមេ NTP ដែលបានកំណត់ទុកជាមុន។ ប្រសិនបើមិនមានការតភ្ជាប់អ៊ីធឺណិតទេ កំណត់រចនាសម្ព័ន្ធម៉ាស៊ីនមេ NTP មូលដ្ឋាន ហើយបញ្ចូលអាសយដ្ឋាន IP របស់វា។

បើកដំណើរការ RESTful API

1. ចូលទៅក្នុងឧបករណ៍ web ចំណុចប្រទាក់ ហើយចូលទៅកាន់ផ្ទាំងគ្រប់គ្រងការកំណត់កម្រិតខ្ពស់។
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 = ១
4. Sci.admin.pwd =
5. រក្សាទុក និងបង្ហោះការកំណត់ដែលបានកែប្រែ file ត្រលប់ទៅឧបករណ៍ដោយប្រើការកំណត់រចនាសម្ព័ន្ធឡើងវិញ File មុខងារនៅក្នុងផ្ទាំង ថែទាំប្រព័ន្ធ។

ការផ្ទៀងផ្ទាត់ Sampលេខកូដឡឺ

សូមផ្ញើអ៊ីមែល support@algosolutions.com ប្រសិនបើអ្នកចង់បានស្តង់ដារ ឬការផ្ទៀងផ្ទាត់មូលដ្ឋាន sampលេខកូដ។
សម្រាប់ជំនួយបន្ថែម សូមទូរស័ព្ទទៅ ៨៦៦-៤៤៧-២១៩៤ ឬអ៊ីមែល support@algosolutions.com

សេចក្តីជូនដំណឹងអំពីព័ត៌មាន

ចំណាំ
ចំណាំបង្ហាញពីបច្ចុប្បន្នភាព ពត៌មាន និងការណែនាំដែលមានប្រយោជន៍ ដែលគួរអនុវត្តតាម

ការបដិសេធ

ព័ត៌មានដែលមាននៅក្នុងឯកសារនេះត្រូវបានគេជឿថាមានភាពត្រឹមត្រូវក្នុងគ្រប់ទិដ្ឋភាពទាំងអស់ ប៉ុន្តែមិនត្រូវបានធានាដោយ Algo ទេ។ ព័ត៌មានគឺអាចផ្លាស់ប្តូរដោយគ្មានការជូនដំណឹងជាមុន ហើយមិនគួរត្រូវបានបកស្រាយតាមមធ្យោបាយណាមួយជាការប្តេជ្ញាចិត្តដោយ Algo ឬសាខាណាមួយ ឬក្រុមហ៊ុនបុត្រសម្ព័ន្ធរបស់ខ្លួន។ Algo និងសាខា និងក្រុមហ៊ុនបុត្រសម្ព័ន្ធរបស់ខ្លួនមិនទទួលខុសត្រូវចំពោះកំហុស ឬការខកខានណាមួយនៅក្នុងឯកសារនេះទេ។ ការកែប្រែឯកសារនេះ ឬការបោះពុម្ពថ្មីរបស់វាអាចត្រូវបានចេញ ដើម្បីបញ្ចូលការផ្លាស់ប្តូរបែបនេះ។ Algo សន្មត់ថាមិនទទួលខុសត្រូវចំពោះការខូចខាត ឬការទាមទារដែលបណ្តាលមកពីការប្រើប្រាស់សៀវភៅណែនាំនេះ ឬផលិតផល សូហ្វវែរ កម្មវិធីបង្កប់ និង/ឬផ្នែករឹង។ គ្មានផ្នែកនៃឯកសារនេះអាចត្រូវបានផលិតឡើងវិញ ឬបញ្ជូនតាមទម្រង់ណាមួយ ឬដោយមធ្យោបាយណាមួយឡើយ - អេឡិចត្រូនិក ឬមេកានិច - សម្រាប់គោលបំណងណាមួយដោយគ្មានការអនុញ្ញាតជាលាយលក្ខណ៍អក្សរពី Algo ។
សម្រាប់ព័ត៌មានបន្ថែម ឬជំនួយបច្ចេកទេសនៅអាមេរិកខាងជើង សូមទាក់ទងក្រុមគាំទ្ររបស់ Algo៖

ជំនួយបច្ចេកទេស Algo
1-៨៦៦-៤៤៧-២១៩៤
support@algosolutions.com

©2022 Algo គឺជាពាណិជ្ជសញ្ញាចុះបញ្ជីរបស់ Algo Communication Products Ltd.
រក្សា​រ​សិទ្ធ​គ្រប់យ៉ាង។ ពាណិជ្ជសញ្ញាផ្សេងទៀតទាំងអស់គឺជាកម្មសិទ្ធិរបស់ម្ចាស់រៀងៗខ្លួន។ លក្ខណៈ​ពិសេស​ទាំង​អស់​អាច​មាន​ការ​ផ្លាស់​ប្តូរ​ដោយ​គ្មាន​ការ​ជូន​ដំណឹង។

 ទូទៅ

សេចក្តីផ្តើម

ឯកសារនេះពិពណ៌នាអំពីរបៀបដែល Algo RESTful API អាចត្រូវបានប្រើដើម្បីចូលប្រើ រៀបចំ និងចាប់ផ្តើមសកម្មភាពនៅលើ 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 (Network Time Protocol) កំពុងប្រើប្រាស់។ អាសយដ្ឋានរបស់ម៉ាស៊ីនមេ NTP ផ្ទាល់ខ្លួនអាចត្រូវបានកំណត់រចនាសម្ព័ន្ធនៅក្នុងការកំណត់កម្រិតខ្ពស់ → ផ្ទាំងពេលវេលា។

ចំណាំ
ម៉ាស៊ីនមេ NTP ដែលបានកំណត់រចនាសម្ព័ន្ធជាមុនត្រូវបានបង្ហោះជាសាធារណៈ ដូច្នេះការតភ្ជាប់អ៊ីនធឺណិតត្រូវបានទាមទារដើម្បីទៅដល់វា។ ប្រសិនបើមិនមានការតភ្ជាប់អ៊ីធឺណិតទេ កំណត់រចនាសម្ព័ន្ធម៉ាស៊ីនមេ NTP មូលដ្ឋាន ហើយបញ្ចូលអាសយដ្ឋាន IP របស់វា។

• ត្រូវប្រាកដថាពេលវេលាប្រព័ន្ធឧបករណ៍ Algo ត្រូវបានកែតម្រូវទៅតាមតំបន់ពេលវេលាត្រឹមត្រូវ។ នេះអាចត្រូវបានធ្វើដោយចូលទៅកាន់ការកំណត់កម្រិតខ្ពស់ → ផ្ទាំងពេលវេលា។

 បើកដំណើរការ RESTful API

1. ចូលទៅក្នុង web ចំណុចប្រទាក់ ហើយចូលទៅកាន់ការកំណត់កម្រិតខ្ពស់ → ផ្ទាំងគ្រប់គ្រង។
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 = ១
   Sci.admin.pwd =
3.  រក្សាទុក និងបង្ហោះការកំណត់ដែលបានកែប្រែ file ត្រលប់ទៅឧបករណ៍ដោយប្រើការកំណត់រចនាសម្ព័ន្ធឡើងវិញ File មុខងារនៅក្នុងផ្ទាំង ប្រព័ន្ធ → ថែទាំ។

តម្រូវការផ្ទៀងផ្ទាត់

សូមផ្ញើអ៊ីមែល support@algosolutions.com ប្រសិនបើអ្នកចង់បានស្តង់ដារ ឬការផ្ទៀងផ្ទាត់មូលដ្ឋាន sampលេខកូដ។

សំណើការផ្ទៀងផ្ទាត់ស្តង់ដារជាមួយនឹង JSON Payload

បឋមកថាដែលត្រូវការនៅក្នុងសំណើ HTTP/HTTPS
> ប្រភេទមាតិកា៖ “application/json”
> មាតិកា-MD5៖ [content_md5] ឧample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

ការអនុញ្ញាត៖ hmac admin៖ [nonce]: [hmac_output]
បឋមកថាអនុញ្ញាតមាន៖

1. ខ្សែអក្សរ 'hmac admin' បន្តដោយសញ្ញា ':' ។
2. Nonce – តម្លៃចៃដន្យ ឬមិនធ្វើម្តងទៀត អមដោយសញ្ញា ':' ។
3. Hmac_output – បង្កើតដោយ RESTful API Password (secret-key) ដែលបានកំណត់រចនាសម្ព័ន្ធនៅលើឧបករណ៍របស់អ្នក និងការបញ្ចូល HMAC ដូចខាងក្រោម៖
   [request_method]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[គ្មាន]

ការបញ្ចូល HMAC ឧample: (ប្រើ 'algo' ជាគន្លឹះសម្ងាត់)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 បង្កើត HMAC ជាមួយពាក្យសម្ងាត់ និងខ្សែអក្សរបញ្ចូល HMAC ជាការសង្ខេបដោយប្រើ SHA-256៖
ទិន្នផល HMAC ឧample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

កាលបរិច្ឆេទ៖ ថ្ងៃ ខែ កាលបរិច្ឆេទ ឆ្នាំ ម៉ោង៖ នាទី៖ វិនាទី GMT
Example
កាលបរិច្ឆេទ៖ ថ្ងៃព្រហស្បតិ៍ ទី២២ ខែកញ្ញា ឆ្នាំ២០២២ ម៉ោង ០២:៣៣:០៧ GMT
ការផ្ទៀងផ្ទាត់ស្តង់ដារជាមួយ payload exampលេ៖

 សំណើការផ្ទៀងផ្ទាត់ស្តង់ដារដោយគ្មាន JSON Payload

ដូចគ្នាបេះបិទទៅនឹង 3.1 ជាមួយនឹងមាតិកាដែលទាក់ទងនឹងបឋមកថា/ការបញ្ចូល hmac ត្រូវបានលុបចោល។
ការបញ្ចូល HMAC៖ [request_method]:[request_uri]:[timestamp]:[nonce] HMAC input example: (ប្រើ 'algo' ជាគន្លឹះសម្ងាត់)
GET:/api/settings/audio.page.vol:1601312252:49936
បង្កើត HMAC ដោយប្រើពាក្យសម្ងាត់ និងខ្សែអក្សរបញ្ចូល HMAC ដោយប្រើ SHA-256៖
ទិន្នផល HMAC ឧample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
ការផ្ទៀងផ្ទាត់ស្តង់ដារដោយគ្មាន payload ឧampលេ៖

 សំណើផ្ទៀងផ្ទាត់មូលដ្ឋាន

វិធីសាស្រ្តនៃការផ្ទៀងផ្ទាត់នេះគួរតែត្រូវបានប្រើដោយប្រុងប្រយ័ត្នព្រោះវាមិនសូវមានសុវត្ថិភាពជាងវិធីសាស្ត្រស្តង់ដារ។

ការអនុញ្ញាត៖ មូលដ្ឋាន [base64]
Exampលេ៖
ការអនុញ្ញាត៖ មូលដ្ឋាន YWRtaW46YWxnbwo=
ការផ្ទៀងផ្ទាត់មូលដ្ឋាន ឧampលេ៖

បញ្ជា

 ពាក្យបញ្ជា RESTful API

ខាងក្រោមនេះគឺជាបញ្ជីនៃពាក្យបញ្ជា API ដែលគាំទ្រទាំងអស់។

ចំណាំ
សំណើ PUT ផ្លាស់ប្តូរ ឬបង្កើតធនធានអចិន្ត្រៃយ៍ដែលរួចផុតពីការចាប់ផ្ដើមឡើងវិញ ខណៈពេលដែលសំណើ POST គ្រប់គ្រងឧបករណ៍សម្រាប់វគ្គបច្ចុប្បន្នប៉ុណ្ណោះ។

ការពិពណ៌នា	វិធីសាស្រ្ត	URI	បន្ទុក ប៉ារ៉ាម៉ែត្រ	ត្រឡប់មកវិញ Example	ផលិតផល	FW
ទាញយកតម្លៃនៃប៉ារ៉ាម៉ែត្រជាក់លាក់មួយ។	ទទួលបាន	/api/settings/[key-name] Ex./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”: “idle”} ឬ {“input.relay.status”: “active”}	ផលិតផលទាំងអស់ជាមួយនឹងការបញ្ចូលបញ្ជូនត លើកលែងតែ 8063។ សូមមើលខាងក្រោម។	> 4.1
ស្រង់ចេញស្ថានភាពនៃស្ថានីយបញ្ចូល 1 ឬបញ្ចូល 2 ។	ទទួលបាន	/api/info/input.relay1.status ឬ /api/info/input.relay2.status	គ្មាន	{“input.relay1.status”: “idle”} ឬ {“input.relay1.status”: “active”}	8063	> 4.1
ទាញយកបញ្ជីសម្លេង files បានដំឡើងបច្ចុប្បន្ន។	ទទួលបាន	/api/info/tonelist	គ្មាន	{“បញ្ជីសំឡេង”៖[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	ទាំងអស់។	> 5.0
ទាញយកព័ត៌មានឧបករណ៍ដែលត្រូវបានបង្ហាញនៅលើទំព័រស្ថានភាព។	ទទួលបាន	/api/info/ស្ថានភាព	គ្មាន	បញ្ជីព័ត៌មានពេញលេញពីផ្ទាំងស្ថានភាព។	ទាំងអស់។	> 5.4

ទាញយកព័ត៌មានផលិតផលដែលត្រូវបានបង្ហាញនៅលើទំព័រអំពី។	ទទួលបាន	/api/info/about	គ្មាន	ព័ត៌មានទាំងអស់បង្ហាញនៅលើផ្ទាំងអំពី។	ទាំងអស់។	> 5.4
ធ្វើឱ្យ strobe សកម្មជាមួយនឹងប៉ារ៉ាម៉ែត្រពណ៌ និងលំនាំដែលចង់បាន។	ប្រកាស	/api/controls/strobe/start	លំនាំ៖ {0 – 15} color1: {blue, red, amber, green} color2: {blue, red, amber, green} ledlvl: {1 – 255} ការកាន់កាប់៖ {ពិត មិនពិត}	គ្មាន	8128(G2) 8138 8190 ស	> 3.3
បញ្ឈប់ strobe ។	ប្រកាស	/api/controls/strobe/stop	គ្មាន	គ្មាន	8128(G2) 8138 8190 ស	> 3.3
លេង​សំឡេង​មួយ​ដង​ឬ​រង្វិលជុំ​វា​។	ប្រកាស	/api/controls/tone/start	ផ្លូវ៖ {សម្លេង} ឧ។ chime.wav រង្វិលជុំ៖ {ពិត មិនពិត} ឬ {0, 1} ឧទាហរណ៍ {“path”:”chime.wav”, “loop”: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	{"ផ្នែកបន្ថែម":"2099", “tone”:”gong.wav”, “interval”:”0″, “maxdur”:”10″}	គ្មាន	វាគ្មិន 8301 8410 8420	> 3.3
បញ្ចប់ការហៅទូរសព្ទ។	ប្រកាស	/api/controls/call/stop	គ្មាន	គ្មាន	វាគ្មិន 8301 8410 8420	> 3.3

ចាប់ផ្តើមការហៅទំព័រមួយផ្លូវ។ ឧបករណ៍នេះនឹងទទួលបានស្ទ្រីមអូឌីយ៉ូពីផ្នែកបន្ថែមគោលដៅ។	ប្រកាស	/api/controls/call/page	{“ផ្នែកបន្ថែម”៖” ”}	គ្មាន	វាគ្មិន 8410 8420	> 5.3.4
ចាប់ផ្តើមចំណុចបញ្ចប់គោលដៅឡើងវិញ។	ប្រកាស	/api/controls/reboot	គ្មាន	គ្មាន	ទាំងអស់។	> 3.3
ដោះសោទ្វារ។ "មូលដ្ឋាន" គ្រប់គ្រងការបញ្ជូនតមូលដ្ឋាន "netdc1" គ្រប់គ្រងឧបករណ៍បញ្ជាទ្វារបណ្តាញពីចម្ងាយ (8063)	ប្រកាស	/api/controls/door/unlock	doorid៖ {local, netdc1} * ស្រេចចិត្ត	គ្មាន	8039 8028(G2) 8201 8063	> 3.3
ចាក់សោ។	ប្រកាស	/api/controls/door/lock	doorid៖ {local, netdc1} * ស្រេចចិត្ត	គ្មាន	8039 8028(G2) 8201 8063	> 3.3
បើកការបញ្ជូនត aux out 24v ។	ប្រកាស	api/controls/24v/បើកដំណើរការ	គ្មាន	គ្មាន	8063	> 5.0
បិទការបញ្ជូនត aux out 24v ។	ប្រកាស	api/controls/24v/បិទ	គ្មាន	គ្មាន	8063	> 5.0
បើកដំណើរការបញ្ជូនតលទ្ធផល។	ប្រកាស	/api/controls/relay/enable	គ្មាន	គ្មាន	8063	> 5.0
បិទការបញ្ជូនតលទ្ធផល។	ប្រកាស	/api/controls/relay/disable	គ្មាន	គ្មាន	8063	> 5.0
ពិនិត្យម៉ាស៊ីនមេកម្មវិធីបង្កប់របស់ Algo សម្រាប់កំណែកម្មវិធីបង្កប់ចុងក្រោយបំផុត។	ប្រកាស	/api/controls/upgrade/check	គ្មាន	{“កំណែ”៖ “បានធ្វើបច្ចុប្បន្នភាព”} ឬ {“កំណែ”៖ “ ”}	ទាំងអស់។	> 4.1
ពិនិត្យម៉ាស៊ីនមេកម្មវិធីបង្កប់របស់ Algo សម្រាប់កំណែកម្មវិធីបង្កប់ចុងក្រោយបំផុត និងដំឡើងកំណែទៅកំណែនោះ។	ប្រកាស	/api/controls/upgrade/start	គ្មាន	{“ស្ថានភាព”៖ “បានធ្វើបច្ចុប្បន្នភាព”} ឬ {“ស្ថានភាព”៖ “ការធ្វើឱ្យប្រសើរ ”, “url”: url>} ឬ {“ស្ថានភាព”៖ “ ”}	ទាំងអស់។	> 4.1
បង្ហាញរូបភាព ឬលំនាំនៅលើអេក្រង់។	ប្រកាស	/api/controls/screen/start	សូមមើល ខាងក្រោម	គ្មាន	8410 8420	> 5.3.4
បញ្ឈប់លំនាំអេក្រង់ ហើយត្រឡប់ទៅអេក្រង់លំនាំដើមវិញ។	ប្រកាស	/api/controls/screen/stop	គ្មាន	គ្មាន	8410 8420	> 5.3.4

ចាប់ផ្តើមកម្មវិធីសំខាន់ឡើងវិញ។	ប្រកាស	/api/controls/ផ្ទុកឡើងវិញ	គ្មាន	គ្មាន	ទាំងអស់។	> 5.3.4
ចាប់ផ្តើមស្តាប់ការផ្សាយសំឡេងផ្ទាល់។ កំណត់រចនាសម្ព័ន្ធលេខច្រកដែលស្ទ្រីមកំពុងត្រូវបានផ្ញើ។	ប្រកាស	/api/controls/rx/start	{“ច្រក”៖ }	គ្មាន	ទាំងអស់។	> 5.3.4
ឈប់ស្តាប់ស្ទ្រីមអូឌីយ៉ូផ្ទាល់។	ប្រកាស	/api/controls/rx/stop	គ្មាន	គ្មាន	ទាំងអស់។	> 5.3.4
កំណត់របៀបពហុខាស។	ដាក់	/api/state/mcast/update/	{"របៀប":"អ្នកផ្ញើ", "អាសយដ្ឋាន"៖ , "ច្រក": , “type”:”rtp”} ឬ {“mode”:”sender”, “address”: , "ច្រក": , “type”:”poly”, “group”:1} **ចំណាំ**៖ ប្រសិនបើ controls/tone/start ត្រូវបានប្រើមុនពេលពាក្យបញ្ជានេះ សម្លេងនឹងលេងដោយប្រើការកំណត់បច្ចុប្បន្ននៅលើ web UI ។	គ្មាន	8301	> 5.0
បញ្ចូលតម្លៃទៅប៉ារ៉ាម៉ែត្រជាក់លាក់មួយពី JSON payload ។	ដាក់	/api/ការកំណត់	ប៉ារ៉ាម៉ែត្រ៖ {value} ឧទាហរណ៍ {“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/do ឬ/unlock	doorid៖ {local, netdc1} * ស្រេចចិត្ត	8039 8028(G2) 8201 8063	> 3.3
ចាក់សោ។	/sci/controls/do or/lock	doorid៖ {local, netdc1} * ស្រេចចិត្ត	8039 8028(G2) 8201 8063	> 3.3
លេង​សំឡេង​មួយ​ដង​ឬ​រង្វិលជុំ​វា​។	/sci/controls/to ne/start	ផ្លូវ៖ {សម្លេង} ឧ។ chime.wav រង្វិលជុំ៖ {ពិត មិនពិត} ឬ {0, 1}	ទាំងអស់។	> 3.3
បញ្ឈប់សម្លេង។	/sci/controls/to ne/stop	គ្មាន	ទាំងអស់។	> 3.3
ធ្វើឱ្យ strobe សកម្មជាមួយនឹងប៉ារ៉ាម៉ែត្រពណ៌ និងលំនាំដែលចង់បាន។	/sci/controls/strobe/start	លំនាំ៖ {0 – 15} color1: {ពណ៌ខៀវ, ក្រហម, amber, បៃតង} color2: {ខៀវ, ក្រហម, លឿងខ្ចី, បៃតង} ledlvl៖ {1 – 255} ការកាន់កាប់៖ {ពិត មិនពិត}	8128(G2) 8138 8190 ស	> 3.3
បញ្ឈប់ strobe ។	/sci/controls/strobe/stop	គ្មាន	8128(G2) 8138 8190 ស	> 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

ឯកសារយោង

• សៀវភៅណែនាំអ្នកប្រើប្រាស់