ALGO RESTful API

ထုတ်ကုန်အချက်အလက်- RESTful API လမ်းညွှန်

Algo RESTful API သည် သုံးစွဲသူများအား HTTP/HTTPS တောင်းဆိုမှုများမှတစ်ဆင့် ၎င်းတို့၏ကွန်ရက်ရှိ Algo IP Endpoints တွင် လုပ်ဆောင်ချက်များကို ဝင်ရောက်ကြည့်ရှုနိုင်၊ ကိုင်တွယ်ရန်နှင့် အစပျိုးရန် ခွင့်ပြုပေးပါသည်။ ဤစာရွက်စာတမ်းသည် Algo စက်ပစ္စည်းများနှင့် အပြန်အလှန်တုံ့ပြန်ရန်အတွက် အသုံးပြုနိုင်သည့် နိုင်ငံမဲ့လုပ်ဆောင်မှုများ၏ ယူနီဖောင်းနှင့် ကြိုတင်သတ်မှတ်ထားသော အစုအဝေးတစ်ခုကို ပေးပါသည်။ API သည် JSON payloads ဖြင့် HTTP/HTTPS GET၊ POST နှင့် PUT တောင်းဆိုချက်များကို ပံ့ပိုးပေးသည်။

အထောက်အထားပြခြင်း။

Algo RESTful API ဖြင့် ရရှိနိုင်သော စစ်မှန်ကြောင်းအထောက်အထားသုံးမျိုးရှိပါသည်။

• ပုံမှန်စစ်မှန်ကြောင်းအထောက်အထား (မူလအားဖြင့်ဖွင့်ထားသည်)
• အခြေခံ စစ်မှန်ကြောင်း အတည်ပြုခြင်း (ချန်လှပ်ထားနိုင်သည်)
• စစ်မှန်ကြောင်းအထောက်အထားမရှိပါ (မထောက်ခံပါ၊ စမ်းသပ်ရန်အတွက်သာ)

ထုတ်ကုန်အသုံးပြုမှု လမ်းညွှန်ချက်များ- RESTful API

လိုအပ်ချက်များ

RESTful API ကိုမဖွင့်မီ၊ ကြိုတင်ပြင်ဆင်ထားသော NTP ဆာဗာများထံရောက်ရှိရန် စက်ပစ္စည်းတွင် အင်တာနက်ချိတ်ဆက်မှုရှိကြောင်း သေချာပါစေ။ အင်တာနက်ချိတ်ဆက်မှု မရရှိနိုင်ပါက၊ ဒေသခံ NTP ဆာဗာကို စီစဉ်သတ်မှတ်ပြီး ၎င်း၏ IP လိပ်စာကို ထည့်သွင်းပါ။

RESTful API ကိုဖွင့်ခြင်း။

1. ကိရိယာ၏ထဲသို့ဝင်ပါ။ web အင်တာဖေ့စ်နှင့် အဆင့်မြင့် ဆက်တင်များ စီမံခန့်ခွဲသူ တက်ဘ်သို့ သွားပါ။
2. API ပံ့ပိုးမှုအပိုင်းသို့ဆင်းပြီး RESTful API ကိုဖွင့်ပါ။
3. အလိုရှိသော စကားဝှက်ကို သတ်မှတ်ပါ (မူလ စကားဝှက်- အယ်လ်ဂို)။ ပုံမှန်စစ်မှန်ကြောင်းအထောက်အထားကို မူရင်းအတိုင်း ဖွင့်ထားကြောင်း သတိပြုပါ။

အခြေခံ စစ်မှန်ကြောင်းအထောက်အထားကို ဖွင့်ခြင်း (ချန်လှပ်ထားနိုင်သည်)

1. ၌ web အင်တာဖေ့စ်၊ စနစ်ထိန်းသိမ်းမှုတက်ဘ်သို့ သွား၍ ဖွဲ့စည်းမှုပုံစံကို ဒေါင်းလုဒ်လုပ်ပါ။ file.
2. configuration ကိုဖွင့်ပါ file မည်သည့်စာသားတည်းဖြတ်မှုဖြင့်မဆို အောက်ပါစာကြောင်းကို ထည့်ပါ- api.auth.basic = 1
3. ပြင်ဆင်ထားသော ဖွဲ့စည်းမှုပုံစံကို သိမ်းဆည်းပြီး အပ်လုဒ်လုပ်ပါ။ file Restore Configuration ကို အသုံးပြု၍ စက်သို့ ပြန်သွားပါ။ File စနစ်ထိန်းသိမ်းမှုတက်ဘ်ရှိ အင်္ဂါရပ်။

အထောက်အထားမခိုင်လုံသောနည်းလမ်းကို ဖွင့်ခြင်း (ချန်လှပ်ထားနိုင်သည်)

စစ်မှန်ကြောင်းအထောက်အထားမရှိသောနည်းလမ်းကိုဖွင့်ရန် RESTful API စကားဝှက်အကွက်ကို ကွက်လပ်ထားပါ။ ဤနည်းလမ်းကို အကြံပြုထားခြင်းမရှိသော်လည်း ၎င်းသည် လုံခြုံမှုမရှိသောကြောင့်သာ စမ်းသပ်ရန်အတွက်သာ အသုံးပြုသင့်သည်။

ရိုးရှင်းသော ထိန်းချုပ်မှု အင်တာဖေ့စ်ကို ဖွင့်ခြင်း (ချန်လှပ်ထားနိုင်သည်)

1. ဂရန် web အင်တာဖေ့စ်၊ စနစ်ထိန်းသိမ်းမှုတက်ဘ်သို့ သွား၍ ဖွဲ့စည်းမှုပုံစံကို ဒေါင်းလုဒ်လုပ်ပါ။ file.
2. configuration ကိုဖွင့်ပါ file စာသားတည်းဖြတ်သူကို အသုံးပြု၍ စာကြောင်းနှစ်ကြောင်းထည့်ပါ။ သင်အလိုရှိသော စကားဝှက်သို့ ပြောင်းပါ။
3. အက်မင်။web.sci = ၁
4. Sci.admin.pwd = သိပ္ပံပညာ
5. ပြင်ဆင်ထားသော ဖွဲ့စည်းမှုပုံစံကို သိမ်းဆည်းပြီး အပ်လုဒ်လုပ်ပါ။ file Restore Configuration ကို အသုံးပြု၍ စက်သို့ ပြန်သွားပါ။ File စနစ်ထိန်းသိမ်းမှုတက်ဘ်ရှိ အင်္ဂါရပ်။

အထောက်အထားပြခြင်း Sample ကုဒ်

ကျေးဇူးပြု၍ အီးမေးလ်ပို့ပါ။ support@algosolutions.com အကယ်၍ သင်သည် စံ သို့မဟုတ် အခြေခံ စစ်မှန်ကြောင်း အထောက်အထားကို လိုချင်ပါက၊ample ကုဒ်
အပိုအကူအညီအတွက် ဖုန်းခေါ်ဆိုပါ။ ၇၃၆-၇၈၄-၆၀၉၄ သို့မဟုတ် အီးမေးလ် support@algosolutions.com

သတင်းအချက်များ

မှတ်ချက်
မှတ်စုသည် လိုက်နာသင့်သော အသုံးဝင်သော အပ်ဒိတ်များ၊ အချက်အလက်များနှင့် ညွှန်ကြားချက်များကို ညွှန်ပြသည်။

ရှင်းလင်းချက်

ဤစာရွက်စာတမ်းတွင်ပါရှိသော အချက်အလက်သည် ကဏ္ဍတိုင်းတွင် တိကျသည်ဟု ယူဆသော်လည်း Algo မှ အာမခံချက်မရှိပါ။ သတင်းအချက်အလက်သည် အသိပေးခြင်းမရှိဘဲ ပြောင်းလဲသွားတတ်ပြီး Algo သို့မဟုတ် ၎င်း၏ တွဲဖက် သို့မဟုတ် လက်အောက်ခံ ကုမ္ပဏီများ၏ ကတိကဝတ်အဖြစ် မည်သည့်နည်းဖြင့်မဆို အဓိပ္ပာယ်ဖွင့်ဆိုခြင်းမပြုသင့်ပါ။ Algo နှင့် ၎င်း၏လုပ်ငန်းခွဲများနှင့် လုပ်ငန်းခွဲများသည် ဤစာရွက်စာတမ်းရှိ အမှားအယွင်းများ သို့မဟုတ် ပျက်ကွက်မှုများအတွက် တာဝန်မရှိဟု ယူဆပါသည်။ ဤစာတမ်း၏ တည်းဖြတ်မှုများ သို့မဟုတ် တည်းဖြတ်မှုအသစ်များကို ထုတ်ပေးနိုင်သည်။ Algo သည် ဤလက်စွဲစာအုပ် သို့မဟုတ် ထိုကဲ့သို့သောထုတ်ကုန်များ၊ ဆော့ဖ်ဝဲလ်၊ ဖိုင်းဝဲနှင့်/သို့မဟုတ် ဟာ့ဒ်ဝဲအသုံးပြုမှုတို့မှ ထွက်ပေါ်လာသော ပျက်စီးဆုံးရှုံးမှု သို့မဟုတ် အရေးဆိုမှုများအတွက် တာ၀န်မရှိဟု ယူဆပါသည်။ Algo ထံမှ စာဖြင့်ရေးသားခွင့်ပြုချက်မရှိဘဲ မည်သည့်ရည်ရွယ်ချက်အတွက်မဆို - အီလက်ထရွန်းနစ် သို့မဟုတ် စက်ပိုင်းဆိုင်ရာ - ဤစာရွက်စာတမ်း၏ အစိတ်အပိုင်းကို မည်သည့်ပုံစံဖြင့် သို့မဟုတ် မည်သည့်နည်းလမ်းဖြင့်မဆို ပြန်လည်ထုတ်လုပ်ခြင်း သို့မဟုတ် ထုတ်လွှင့်ခြင်းမပြုနိုင်ပါ။
မြောက်အမေရိကရှိ နောက်ထပ်အချက်အလက်များ သို့မဟုတ် နည်းပညာအကူအညီအတွက် Algo ၏ပံ့ပိုးကူညီမှုအဖွဲ့ထံ ဆက်သွယ်ပါ။

Algo နည်းပညာပံ့ပိုးမှု
1-၇၃၆-၇၈၄-၆၀၉၄
support@algosolutions.com

©2022 Algo သည် Algo Communication Products Ltd ၏ မှတ်ပုံတင်ထားသော ကုန်အမှတ်တံဆိပ်တစ်ခုဖြစ်သည်။
မူပိုင်ခွင့်ကိုလက်ဝယ်ထားသည်။ အခြားကုန်အမှတ်တံဆိပ်အားလုံးသည် သက်ဆိုင်ရာပိုင်ရှင်များ၏ ပိုင်ဆိုင်မှုဖြစ်သည်။ Specs အားလုံးကို အသိပေးခြင်းမရှိဘဲ ပြောင်းလဲနိုင်ပါသည်။

 အထွေထွေ

နိဒါန်း

ဤစာတမ်းတွင် Algo RESTful API ကို HTTP/HTTPS တောင်းဆိုမှုများမှတစ်ဆင့် သင့်ကွန်ရက်ရှိ Algo IP Endpoints တွင် လုပ်ဆောင်ချက်များကို ဝင်ရောက်ရန်၊ စီမံခန့်ခွဲရန်နှင့် အစပျိုးရန် မည်ကဲ့သို့အသုံးပြုရမည်ကို ဖော်ပြထားပြီး၊ လုံခြုံရေးအဆင့်အမျိုးမျိုးဖြင့် ကွဲပြားသော အထောက်အထားစိစစ်ခြင်းနည်းလမ်းအချို့ကို ဤစာတမ်းတွင် ဖော်ပြထားသည်။ တောင်းဆိုခြင်းစနစ်များသည် ဤစာရွက်စာတမ်းတွင် သတ်မှတ်ထားသော တူညီသောနှင့် ကြိုတင်သတ်မှတ်ထားသော နိုင်ငံမဲ့လုပ်ဆောင်မှုအစုတစ်ခုမှတစ်ဆင့် Algo စက်များနှင့် အပြန်အလှန်အကျိုးသက်ရောက်နိုင်သည်။ တောင်းဆိုချက်များကို JSON ပေးဆောင်မှုဖြင့် အရင်းအမြစ်၏ URI သို့ ပြုလုပ်ပြီး JSON တုံ့ပြန်မှုကို ထုတ်ယူပါ။ HTTP/HTTPS GET၊ POST နှင့် PUT တောင်းဆိုချက်များကို JSON payload နှင့်အတူ ရင်းမြစ် URI အတွက် ပြုလုပ်သည် ( payloads စာရင်းအတွက် ညွှန်ကြားချက်များကဏ္ဍကို ကြည့်ပါ)။

 အထောက်အထားပြခြင်း။

စစ်မှန်ကြောင်းအထောက်အထားသုံးမျိုးရှိသည်။

•  စံ (အကြံပြုထားသည်)
•  အခြေခံ
•  တစ်ခုမှ (မထောက်ခံပါ)

Standard စစ်မှန်ကြောင်းအထောက်အထားပြခြင်းသည် SHA-256 ကုဒ်နံပါတ်ဖြင့် ဟက်ရှ်အခြေခံ မက်ဆေ့ချ် စစ်မှန်ကြောင်းအထောက်အထားပြကုဒ် (HMAC) ကို အသုံးပြုသည်။ အခြေခံစစ်မှန်ကြောင်းအထောက်အထားပြခြင်းသည် Base64 ကုဒ်နံပါတ်ကိုအသုံးပြုပြီး HTTPS ပေါ်တွင်သာ အသုံးပြုသင့်သည်။ စစ်မှန်ကြောင်းအထောက်အထားမခိုင်လုံသောကြောင့် အလွန်ဂရုစိုက်၍သာ အသုံးပြုသင့်ပါသည်။ အသေးစိတ်အချက်အလက်များအတွက် စစ်မှန်ကြောင်းအထောက်အထားလိုအပ်ချက်များကဏ္ဍကို ကြည့်ပါ။

တပ်ဆင်ခြင်းနှင့် ဖွဲ့စည်းမှု

လိုအပ်ချက်များ

•  ဤစာရွက်စာတမ်းသည် Algo အဆုံးမှတ်သည် ဖာမ်းဝဲလ်ဗားရှင်း 3.3 နှင့်အထက် လုပ်ဆောင်နေသည်ဟု ယူဆသည်။
•  တောင်းဆိုသူနှင့် Algo စက်များကြားရှိ အချိန်ကွာခြားချက်သည် စံအထောက်အထားစိစစ်ခြင်းကို အသုံးပြုရန်အတွက် စက္ကန့် 30 ထက်နည်းသင့်သည်။
• NTP (Network Time Protocol) ကို အသုံးပြုထားကြောင်း သေချာပါစေ။ စိတ်ကြိုက် NTP ဆာဗာများ၏ လိပ်စာများကို Advanced Settings → Time တက်ဘ်တွင် ပြင်ဆင်သတ်မှတ်နိုင်ပါသည်။

မှတ်ချက်
ကြိုတင်ပြင်ဆင်ထားသည့် NTP ဆာဗာများကို အများသူငှာ လက်ခံထားသောကြောင့် ၎င်းကိုရောက်ရှိရန် အင်တာနက်ချိတ်ဆက်မှု လိုအပ်ပါသည်။ အင်တာနက်ချိတ်ဆက်မှု မရရှိနိုင်ပါက၊ ပြည်တွင်း NTP ဆာဗာကို စီစဉ်သတ်မှတ်ပြီး ၎င်း၏ IP လိပ်စာကို ထည့်သွင်းပါ။

• Algo စက်ပစ္စည်းစနစ်အချိန်ကို မှန်ကန်သောအချိန်ဇုန်သို့ ချိန်ညှိထားကြောင်း သေချာပါစေ။ Advanced Settings → Time တက်ဘ်သို့ သွားခြင်းဖြင့် ၎င်းကို လုပ်ဆောင်နိုင်ပါသည်။

 RESTful API ကိုဖွင့်ခြင်း။

1. ထဲကိုဝင်ပါ။ web အင်တာဖေ့စ်နှင့် အဆင့်မြင့် ဆက်တင်များ → စီမံခန့်ခွဲသူ တက်ဘ်သို့ သွားပါ။
2. API ပံ့ပိုးမှုကဏ္ဍသို့ ဆင်းပါ၊ RESTful API ကိုဖွင့်ပြီး စကားဝှက်ကို အလိုရှိသည့်အတိုင်း သတ်မှတ်ပါ (ပုံမှန်စကားဝှက်- algo)
   မှတ်ချက်
   ပုံမှန်စစ်မှန်ကြောင်းအထောက်အထားကို မူရင်းအတိုင်း ဖွင့်ထားသည်။

အခြေခံ စစ်မှန်ကြောင်းအထောက်အထားကို ဖွင့်ပါ (ချန်လှပ်ထားနိုင်သည်)

1. ၌ web အင်တာဖေ့စ်၊ စနစ် → ပြုပြင်ထိန်းသိမ်းမှု တက်ဘ်သို့ သွား၍ ဖွဲ့စည်းမှုပုံစံကို ဒေါင်းလုဒ်လုပ်ပါ။ file.
2. configuration ကိုဖွင့်ပါ file မည်သည့်စာသားတည်းဖြတ်မှုဖြင့်မဆို အောက်ပါစာကြောင်းကို ထည့်ပါ- api.auth.basic = 1
3.  ပြင်ဆင်ထားသော ဖွဲ့စည်းမှုပုံစံကို သိမ်းဆည်းပြီး အပ်လုဒ်လုပ်ပါ။ file Restore Configuration ကို အသုံးပြု၍ စက်သို့ ပြန်သွားပါ။ File စနစ် → ပြုပြင်ထိန်းသိမ်းမှု တက်ဘ်ရှိ အင်္ဂါရပ်။

စစ်မှန်ကြောင်းအထောက်အထားမရှိပါ (ချန်လှပ်ထားနိုင်သည်)

စစ်မှန်ကြောင်းအထောက်အထားမရှိသောနည်းလမ်းကိုဖွင့်ရန် RESTful API စကားဝှက်အကွက်ကို ကွက်လပ်ထားပါ။ ဤနည်းလမ်းကို အကြံပြုထားခြင်းမရှိသော်လည်း ၎င်းသည် လုံခြုံမှုမရှိသောကြောင့်သာ စမ်းသပ်ရန်အတွက်သာ အသုံးပြုသင့်သည်။

ရိုးရှင်းသော ထိန်းချုပ်မှု အင်တာဖေ့စ်ကို ဖွင့်ခြင်း (ချန်လှပ်ထားနိုင်သည်)

1. ဂရန် web အင်တာဖေ့စ်၊ စနစ် → ပြုပြင်ထိန်းသိမ်းမှု တက်ဘ်သို့ သွား၍ ဖွဲ့စည်းမှုပုံစံကို ဒေါင်းလုဒ်လုပ်ပါ။ file.
2.  configuration ကိုဖွင့်ပါ file စာသားတည်းဖြတ်သူကို အသုံးပြု၍ စာကြောင်းနှစ်ကြောင်းထည့်ပါ။ ပြောင်းလဲပါ။ သင်အလိုရှိသော စကားဝှက်သို့ အက်မင်။web.sci = ၁
   Sci.admin.pwd = သိပ္ပံပညာ
3.  ပြင်ဆင်ထားသော ဖွဲ့စည်းမှုပုံစံကို သိမ်းဆည်းပြီး အပ်လုဒ်လုပ်ပါ။ file Restore Configuration ကို အသုံးပြု၍ စက်သို့ ပြန်သွားပါ။ File စနစ် → ပြုပြင်ထိန်းသိမ်းမှု တက်ဘ်ရှိ အင်္ဂါရပ်။

အထောက်အထားစိစစ်ခြင်း လိုအပ်ချက်များ

ကျေးဇူးပြု၍ အီးမေးလ်ပို့ပါ။ support@algosolutions.com အကယ်၍ သင်သည် စံ သို့မဟုတ် အခြေခံ စစ်မှန်ကြောင်း အထောက်အထားကို လိုချင်ပါက၊ample ကုဒ်

JSON Payload ဖြင့် Standard Authentication Request

HTTP/HTTPS တောင်းဆိုမှုတွင် လိုအပ်သော ခေါင်းစီးများ
> အကြောင်းအရာ-အမျိုးအစား- "application/json"
> အကြောင်းအရာ-MD5- [content_md5] Example
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

ခွင့်ပြုချက်- hmac admin-[nonce]-[hmac_output]
ခွင့်ပြုချက်ခေါင်းစီးများတွင်-

1. 'hmac admin' ဟူသော စာကြောင်းနောက်တွင် ကော်လံ ':'။
2. Nonce – ကျပန်း သို့မဟုတ် ထပ်တလဲလဲမဟုတ်သော တန်ဖိုးတစ်ခု၊ နောက်တွင် colon ':'။
3. Hmac_output – သင့်စက်တွင် သတ်မှတ်ထားသော RESTful API စကားဝှက် (လျှို့ဝှက်သော့) မှ ထုတ်ပေးသော အောက်ပါအတိုင်း၊
   [request_method]-[request_uri]-[content_md5]:[content_type]-[အချိန်ဆုံးamp]:[မဟုတ်]

HMAC ထည့်သွင်းမှု ဥပမာample- (လျှို့ဝှက်သော့အဖြစ် 'algo' ကို အသုံးပြု)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 SHA-256 ကို အသုံးပြု၍ HMAC စကားဝှက်နှင့် HMAC ထည့်သွင်းရေးစာကြောင်းကို အချေအတင်အဖြစ် ဖန်တီးပါ။
HMAC အထွက် ဥပမာample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

ရက်စွဲ- နေ့၊ ရက်စွဲ လ၊ နှစ် hr:min:sec GMT
Example
ရက်စွဲ- ကြာသပတေးနေ့၊ စက်တင်ဘာ 22 ရက်၊ 2022 02:33:07 GMT
payload ex ဖြင့် Standard authenticationample-

 JSON Payload မပါပဲ Standard Authentication Request

အကြောင်းအရာဆက်စပ်သော ခေါင်းစီး/hmac ထည့်သွင်းမှုကို ချန်လှပ်ထားခြင်းဖြင့် 3.1 နှင့် တူညီသည်။
HMAC ထည့်သွင်းမှု- [request_method]:[request_uri]-[အချိန်ဆုံးamp]:[nonce] HMAC ထည့်သွင်းမှု example- (လျှို့ဝှက်သော့အဖြစ် 'algo' ကို အသုံးပြု)
ရယူရန်:/api/settings/audio.page.vol:1601312252:49936
SHA-256 ကို အသုံးပြု၍ စကားဝှက်နှင့် HMAC ထည့်သွင်းရေးစာကြောင်းဖြင့် HMAC ကို ဖန်တီးပါ-
HMAC အထွက် ဥပမာample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
payload ex မပါဘဲ Standard စစ်မှန်ကြောင်းအထောက်အထားပြခြင်း။ample-

 အခြေခံစစ်မှန်ကြောင်းအထောက်အထားတောင်းဆိုမှု

ဤနည်းလမ်းကို စံနည်းလမ်းထက် လုံခြုံမှုနည်းသောကြောင့် အထောက်အထားစိစစ်ခြင်းနည်းလမ်းကို ဂရုတစိုက်အသုံးပြုသင့်သည်။

ခွင့်ပြုချက်- အခြေခံ [base64]
Example-
ခွင့်ပြုချက်- အခြေခံ YWRtaW46YWxnbwo=
အခြေခံ စစ်မှန်ကြောင်းအထောက်အထားပြခြင်း example-

အမိန့်

 RESTful API Commands

အောက်တွင် ပံ့ပိုးပေးထားသော API ညွှန်ကြားချက်များအားလုံး၏ စာရင်းတစ်ခုဖြစ်သည်။

မှတ်ချက်
PUT တောင်းဆိုချက်တစ်ခုသည် ပြန်လည်စတင်ခြင်းမှ လွတ်မြောက်နိုင်သည့် အမြဲတမ်းရင်းမြစ်ကို ပြောင်းလဲခြင်း သို့မဟုတ် ဖန်တီးပေးသည့်အရာဖြစ်ပြီး POST တောင်းဆိုချက်သည် လက်ရှိစက်ရှင်အတွက် စက်ပစ္စည်းကိုသာ ထိန်းချုပ်ပါသည်။

ဖော်ပြချက်	နည်းလမ်း	URI	ဝန်ဆောင်ခ ကန့်သတ်ချက်များ	ပြန်လာ Example	ထုတ်ကုန်	FW
သတ်မှတ်ထားသော ကန့်သတ်ဘောင်တစ်ခု၏ တန်ဖိုးကို ရယူပါ။	ရယူပါ။	/api/settings/[key-name] Ex./api/settings/audio.page.vol	မရှိ	{“audio.page.vol”: “-18dB”}	အားလုံး	> ၆၀
decibels ဖြင့်တိုင်းတာသော ပတ်ဝန်းကျင်ဆူညံသံအဆင့်ကို ပြန်ပေးပါ။ ပတ်ဝန်းကျင် ဆူညံသံ လျော်ကြေးပေးခြင်းကို အခြေခံ ဆက်တင်များ -> အင်္ဂါရပ်များ တက်ဘ်တွင် ဖွင့်ထားရပါမည်။	ရယူပါ။	/api/info/audio.noise.level	မရှိ	{“audio.noise.level”: 72}	စပီကာများ ပြသသည့် စပီကာများ	> ၆၀
relay input terminal ၏ အခြေအနေကို ထုတ်ယူပါ။	ရယူပါ။	/api/info/input.relay.status	မရှိ	{“input.relay.status”: “idle”} သို့မဟုတ် {“input.relay.status”: “active”}	8063 မှလွဲ၍ relay input ပါရှိသည့် ထုတ်ကုန်အားလုံး။ အောက်တွင်ကြည့်ပါ။	> ၆၀
Input 1 သို့မဟုတ် Input 2 terminals ၏ အခြေအနေကို ထုတ်ယူပါ။	ရယူပါ။	/api/info/input.relay1.status သို့မဟုတ် /api/info/input.relay2.status	မရှိ	{“input.relay1.status”: “idle”} သို့မဟုတ် {“input.relay1.status”: “active”}	8063	> ၆၀
လေသံစာရင်းကို ပြန်ယူပါ။ files လက်ရှိထည့်သွင်းထားသည်။	ရယူပါ။	/api/info/tonelist	မရှိ	{“သံစဉ်စာရင်း”-[“bell-na.wav”၊”bell uk.wav”၊”buzzer.wav”၊…]}	အားလုံး	> ၆၀
အခြေအနေစာမျက်နှာတွင်ပြသထားသည့် စက်ပစ္စည်းအချက်အလက်ကို ပြန်လည်ရယူပါ။	ရယူပါ။	/api/info/status	မရှိ	အခြေအနေတက်ဘ်မှ အချက်အလက်အပြည့်အစုံစာရင်း။	အားလုံး	> ၆၀

About စာမျက်နှာတွင်ပြသထားသည့် ထုတ်ကုန်အချက်အလက်ကို ပြန်လည်ရယူပါ။	ရယူပါ။	/api/info/about	မရှိ	အချက်အလက်အားလုံးကို About tab တွင်ပြသထားသည်။	အားလုံး	> ၆၀
လိုချင်သောအရောင်နှင့် ပုံစံဘောင်များဖြင့် strobe ကို အသက်သွင်းပါ။	ပို့စ်	/api/controls/strobe/start	ပုံစံ- {0 – 15} color1- {အပြာ၊ အနီ၊ ပယင်း၊ အစိမ်း} color2- {အပြာ၊ အနီ၊ ပယင်း၊ အစိမ်း} ledlvl- {1 – 255} ပိုင်ဆိုင်မှု- {မှန်၊ မမှန်}	မရှိ	8128(G2) 8138 8190S	> ၆၀
ဖဲကြိုးကို ရပ်လိုက်ပါ။	ပို့စ်	/api/controls/strobe/stop	မရှိ	မရှိ	8128(G2) 8138 8190S	> ၆၀
အသံကို တစ်ကြိမ်တီးပါ သို့မဟုတ် ၎င်းကို လှည့်ပါ။	ပို့စ်	/api/controls/tone/start	လမ်းကြောင်း- {tone} ဆိုလိုသည်မှာ။ chime.wav ကွင်းဆက်- {true၊false} သို့မဟုတ် {0၊ 1} ဥပမာ {“path”:”chime.wav”၊ “loop”:true}	မရှိ	စပီကာ ၂၉ 8373 8028(G2) 8201 8039	> ၆၀
လေသံကို ရပ်လိုက်ပါ။	ပို့စ်	/api/controls/tone/stop	မရှိ	မရှိ	စပီကာ ၂၉ 8373 8028(G2) 8201 8039	> ၆၀
ကြိုတင်မှတ်တမ်းတင်ထားသော မက်ဆေ့ဂျ်ဖြင့် ဖုန်းအဆက်ဆက်ကို ခေါ်ဆိုပါ။	ပို့စ်	/api/controls/call/start	{“တိုးချဲ့မှု”:”2099″၊ "tone":"gong.wav", "interval":"0", "maxdur":"10″}	မရှိ	စပီကာ ၂၉ 8410 8420	> ၆၀
ခေါ်ဆိုမှုကို အဆုံးသတ်ပါ။	ပို့စ်	/api/controls/call/stop	မရှိ	မရှိ	စပီကာ ၂၉ 8410 8420	> ၆၀

တစ်လမ်းသွား စာမျက်နှာခေါ်ဆိုမှုကို စတင်ပါ။ စက်ပစ္စည်းသည် ပစ်မှတ်တိုးချဲ့မှုမှ အသံထုတ်လွှင့်မှုကို လက်ခံရရှိမည်ဖြစ်သည်။	ပို့စ်	/api/controls/call/page	{“တိုးချဲ့မှု”:” ”}	မရှိ	စပီကာ ၂၉ 8420	> ၆၀
ပစ်မှတ်အဆုံးမှတ်ကို ပြန်ဖွင့်ပါ။	ပို့စ်	/api/controls/reboot	မရှိ	မရှိ	အားလုံး	> ၆၀
တံခါးကိုသော့ဖွင့်ပါ။ “local” သည် local relay “netdc1” သည် remote network door controller (8063) ကို ထိန်းချုပ်သည်	ပို့စ်	/api/controls/door/unlock	doorid- {local၊ netdc1} * မလုပ်မနေရ	မရှိ	8039 8028(G2) 8201 8063	> ၆၀
တံခါးကို သော့ခတ်ထားပါ။	ပို့စ်	/api/controls/door/လော့ခ်	doorid- {local၊ netdc1} * မလုပ်မနေရ	မရှိ	8039 8028(G2) 8201 8063	> ၆၀
24v aux out relay ကိုဖွင့်ပါ။	ပို့စ်	api/controls/24v/ဖွင့်ပါ။	မရှိ	မရှိ	8063	> ၆၀
24v aux out relay ကို ပိတ်ပါ။	ပို့စ်	api/controls/24v/disable	မရှိ	မရှိ	8063	> ၆၀
output relay ကိုဖွင့်ပါ။	ပို့စ်	/api/controls/relay/enable	မရှိ	မရှိ	8063	> ၆၀
output relay ကို ပိတ်ပါ။	ပို့စ်	/api/controls/relay/disable	မရှိ	မရှိ	8063	> ၆၀
နောက်ဆုံးထွက် firmware ဗားရှင်းအတွက် Algo ၏ ဖိုင်းဝဲဆာဗာကို စစ်ဆေးပါ။	ပို့စ်	/api/controls/upgrade/check	မရှိ	{"ဗားရှင်း"- "အပ်ဒိတ်လုပ်ထားသည်"} သို့မဟုတ် {“ဗားရှင်း”- “ ”}	အားလုံး	> ၆၀
နောက်ဆုံးထွက် firmware ဗားရှင်းအတွက် Algo ၏ firmware ဆာဗာကို စစ်ဆေးပြီး ထိုဗားရှင်းသို့ အဆင့်မြှင့်ပါ။	ပို့စ်	/api/controls/upgrade/start	မရှိ	{"အခြေအနေ"- "အပ်ဒိတ်လုပ်ထားသည်"} သို့မဟုတ် {"အခြေအနေ"- "အဆင့်မြှင့်တင်ခြင်း။ ”, “url”: url>} သို့မဟုတ် {"အခြေအနေ"- " ”}	အားလုံး	> ၆၀
မျက်နှာပြင်ပေါ်တွင် ရုပ်ပုံ သို့မဟုတ် ပုံစံတစ်ခုကို ပြသပါ။	ပို့စ်	/api/controls/screen/start	ကြည့်ပါ။ အောက်တွင်	မရှိ	8410 8420	> ၆၀
ဖန်သားပြင်ပုံစံကို ရပ်လိုက်ပြီး မူလမျက်နှာပြင်သို့ ပြန်သွားပါ။	ပို့စ်	/api/controls/screen/stop	မရှိ	မရှိ	8410 8420	> ၆၀

ပင်မအပလီကေးရှင်းကို ပြန်လည်စတင်ပါ။	ပို့စ်	/api/controls/reload	မရှိ	မရှိ	အားလုံး	> ၆၀
တိုက်ရိုက်အသံထုတ်လွှင့်မှုကို စတင်နားထောင်ပါ။ ထုတ်လွှင့်နေသည့် ပို့တ်နံပါတ်ကို စီစဉ်သတ်မှတ်ပါ။	ပို့စ်	/api/controls/rx/start	{"ဆိပ်ကမ်း"- }	မရှိ	အားလုံး	> ၆၀
တိုက်ရိုက်အသံလွှင့်ခြင်းအား နားထောင်ခြင်းကို ရပ်ပါ။	ပို့စ်	/api/controls/rx/stop	မရှိ	မရှိ	အားလုံး	> ၆၀
Multicast မုဒ်ကို သတ်မှတ်ပါ။	PUT	/api/state/mcast/update/	{"မုဒ်"-"ပေးပို့သူ", "လိပ်စာ"- , "ဆိပ်ကမ်း"- , “type”:”rtp”} သို့မဟုတ် {“mode”:”ပေးပို့သူ”, “လိပ်စာ”- , "ဆိပ်ကမ်း"- , "type":"poly", "group":1} **မှတ်ချက်**- ဤအမိန့်မတိုင်မီ ထိန်းချုပ်မှုများ/လေသံ/စတင်အသုံးပြုပါက၊ ပေါ်ရှိ လက်ရှိဆက်တင်များကို အသုံးပြု၍ လေသံကို ဖွင့်ပါမည်။ web UI ကို။	မရှိ	8301	> ၆၀
JSON payload မှ သတ်မှတ်ထားသော ဘောင်တစ်ခုသို့ တန်ဖိုးတစ်ခု ထည့်ပါ။	PUT	/api/ဆက်တင်များ	ကန့်သတ်ချက်- {value} ဥပမာ {“audio.page.vol”: “-3dB”}	မရှိ	8180(G2) 8186 8190 8190S 8301 8373	> ၆၀

 ရိုးရှင်းသောထိန်းချုပ်မှုအင်တာဖေ့စ် (SCI) အမိန့်များ

SCI အမိန့်အားလုံးသည် GET တောင်းဆိုမှုများဖြစ်ပြီး စစ်မှန်ကြောင်းအထောက်အထားအတွက် "usi" နှင့် "admin" တွင် ဘုံဘောင်ဘောင်များရှိသည်။
Example-
http ရယူပါ// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

ဖော်ပြချက်	URI	ထပ်လောင်း ဝန်ဆောင်ခ ကန့်သတ်ချက်များ	ထုတ်ကုန်များ	FW
တံခါးကိုသော့ဖွင့်ပါ။ “local” သည် local relay “netdc1” သည် remote network door controller (8063) ကို ထိန်းချုပ်သည်	/sci/controls/do သို့မဟုတ်/unlock	doorid- {local၊ netdc1} * မလုပ်မနေရ	8039 8028(G2) 8201 8063	> ၆၀
တံခါးကို သော့ခတ်ထားပါ။	/sci/controls/do သို့မဟုတ်/lock	doorid- {local၊ netdc1} * မလုပ်မနေရ	8039 8028(G2) 8201 8063	> ၆၀
အသံကို တစ်ကြိမ်တီးပါ သို့မဟုတ် ၎င်းကို လှည့်ပါ။	/sci/controls/to ne/start	လမ်းကြောင်း- {tone} ဆိုလိုသည်မှာ။ chime.wav ကွင်းဆက်- {true၊false} သို့မဟုတ် {0၊ 1}	အားလုံး	> ၆၀
လေသံကို ရပ်လိုက်ပါ။	/sci/controls/to ne/stop	မရှိ	အားလုံး	> ၆၀
လိုချင်သောအရောင်နှင့် ပုံစံဘောင်များဖြင့် strobe ကို အသက်သွင်းပါ။	/sci/controls/strobe/start	ပုံစံ- {0 – 15} color1- {အပြာ၊ အနီရောင်၊ ပယင်း၊ အစိမ်း} အရောင် ၁- {အပြာ၊ အနီ၊ ပယင်း၊ အစိမ်း} ledlvl- {1 – 255} ပိုင်ဆိုင်မှု- {true၊ false}	8128(G2) 8138 8190S	> ၆၀
ဖဲကြိုးကို ရပ်လိုက်ပါ။	/sci/controls/strobe/stop	မရှိ	8128(G2) 8138 8190S	> ၆၀

စာရွက်စာတမ်းများ / အရင်းအမြစ်များ

	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

ကိုးကား

• အသုံးပြုသူလက်စွဲ