ALGO RESTful API

ຂໍ້ມູນຜະລິດຕະພັນ: RESTful API Guide

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 ການໂຕ້ຕອບແລະນໍາທາງໄປຫາແຖບການຕັ້ງຄ່າຂັ້ນສູງ Admin.
2. ເລື່ອນລົງໄປຫາພາກສ່ວນສະຫນັບສະຫນູນ API ແລະເປີດໃຊ້ RESTful API.
3. ຕັ້ງລະຫັດຜ່ານທີ່ຕ້ອງການ (ລະຫັດຜ່ານເລີ່ມຕົ້ນ: algo). ໃຫ້ສັງເກດວ່າການພິສູດຢືນຢັນມາດຕະຖານຖືກເປີດໃຊ້ໂດຍຄ່າເລີ່ມຕົ້ນ.

ເປີດໃຊ້ການພິສູດຢືນຢັນພື້ນຖານ (ທາງເລືອກ)

1. ໃນ web ອິນເຕີເຟດ, ໄປທີ່ແຖບ ການຮັກສາລະບົບ ແລະດາວໂຫລດການຕັ້ງຄ່າ file.
2. ເປີດການຕັ້ງຄ່າ file ກັບຕົວແກ້ໄຂຂໍ້ຄວາມໃດນຶ່ງ ແລະເພີ່ມແຖວຕໍ່ໄປນີ້: api.auth.basic = 1
3. ບັນທຶກ ແລະອັບໂຫລດການຕັ້ງຄ່າທີ່ປ່ຽນແປງ file ກັບໄປທີ່ອຸປະກອນໂດຍໃຊ້ Restore Configuration File ຄຸນນະສົມບັດໃນແຖບການບໍາລຸງຮັກສາລະບົບ.

ການເປີດໃຊ້ງານບໍ່ມີວິທີການກວດສອບຄວາມຖືກຕ້ອງ (ທາງເລືອກ)

ເພື່ອເປີດໃຊ້ວິທີການທີ່ບໍ່ມີການພິສູດຢືນຢັນ, ໃຫ້ຊ່ອງຂໍ້ມູນ RESTful API Password ຫວ່າງເປົ່າ. ວິທີການນີ້ບໍ່ໄດ້ຖືກແນະນໍາແລະຄວນຈະຖືກນໍາໃຊ້ເພື່ອຈຸດປະສົງການທົດສອບເທົ່ານັ້ນຍ້ອນວ່າມັນບໍ່ສະຫນອງຄວາມປອດໄພ.

ເປີດໃຊ້ການໂຕ້ຕອບການຄວບຄຸມແບບງ່າຍດາຍ (ທາງເລືອກ)

1. ສຸດ web ອິນເຕີເຟດ, ໄປທີ່ແຖບ ການຮັກສາລະບົບ ແລະດາວໂຫລດການຕັ້ງຄ່າ file.
2. ເປີດການຕັ້ງຄ່າ file ໃຊ້ຕົວແກ້ໄຂຂໍ້ຄວາມແລະເພີ່ມສອງແຖວ. ປ່ຽນລະຫັດຜ່ານທີ່ຕ້ອງການຂອງທ່ານ.
3. ບໍລິຫານ.web.sci = 1
4. Sci.admin.pwd =
5. ບັນທຶກ ແລະອັບໂຫລດການຕັ້ງຄ່າທີ່ປ່ຽນແປງ file ກັບໄປທີ່ອຸປະກອນໂດຍໃຊ້ Restore Configuration File ຄຸນນະສົມບັດໃນແຖບການບໍາລຸງຮັກສາລະບົບ.

ການ​ກວດ​ສອບ Sampລະຫັດ

ກະລຸນາສົ່ງອີເມວ support@algosolutions.com ຖ້າ​ຫາກ​ວ່າ​ທ່ານ​ຕ້ອງ​ການ​ມາດ​ຕະ​ຖານ​ຫຼື​ການ​ກວດ​ສອບ​ຂັ້ນ​ພື້ນ​ຖານ sampລະຫັດ le.
ສໍາລັບການຊ່ວຍເຫຼືອເພີ່ມເຕີມ, ໂທຫາ 604-454-3792 ຫຼືອີເມລ໌ support@algosolutions.com

ແຈ້ງການຂໍ້ມູນຂ່າວສານ

ໝາຍເຫດ
ຫມາຍເຫດຊີ້ໃຫ້ເຫັນການປັບປຸງທີ່ເປັນປະໂຫຍດ, ຂໍ້ມູນ, ແລະຄໍາແນະນໍາທີ່ຄວນຈະປະຕິບັດຕາມ

ປະຕິເສດຄວາມຮັບຜິດຊອບ

ຂໍ້ມູນທີ່ມີຢູ່ໃນເອກະສານນີ້ແມ່ນເຊື່ອວ່າຖືກຕ້ອງໃນທຸກດ້ານແຕ່ບໍ່ໄດ້ຮັບການຮັບປະກັນໂດຍ Algo. ຂໍ້​ມູນ​ແມ່ນ​ມີ​ການ​ປ່ຽນ​ແປງ​ໂດຍ​ບໍ່​ມີ​ການ​ແຈ້ງ​ການ​ແລະ​ບໍ່​ຄວນ​ຈະ​ໄດ້​ຮັບ​ການ​ສັນ​ຍາ​ໃນ​ວິ​ທີ​ການ​ໃດ​ຫນຶ່ງ​ເປັນ​ຄໍາ​ຫມັ້ນ​ສັນ​ຍາ​ຂອງ Algo ຫຼື​ບໍ​ລິ​ສັດ​ທີ່​ກ່ຽວ​ຂ້ອງ​ຫຼື​ບໍ​ລິ​ສັດ​ຍ່ອຍ​ຂອງ​ຕົນ​. Algo ແລະບໍລິສັດສາຂາ ແລະບໍລິສັດຍ່ອຍບໍ່ຮັບຜິດຊອບຕໍ່ຄວາມຜິດພາດ ຫຼືການລະເວັ້ນໃດໆໃນເອກະສານນີ້. ການແກ້ໄຂເອກະສານນີ້ຫຼືສະບັບໃຫມ່ຂອງມັນອາດຈະຖືກອອກເພື່ອລວມເອົາການປ່ຽນແປງດັ່ງກ່າວ. Algo ບໍ່​ມີ​ຄວາມ​ຮັບ​ຜິດ​ຊອບ​ຕໍ່​ຄວາມ​ເສຍ​ຫາຍ​ຫຼື​ການ​ຮຽກ​ຮ້ອງ​ທີ່​ເກີດ​ຈາກ​ການ​ນໍາ​ໃຊ້​ຄູ່​ມື​ນີ້​ຫຼື​ຜະ​ລິດ​ຕະ​ພັນ​ດັ່ງ​ກ່າວ​, ຊອບ​ແວ​, firmware​, ແລະ / ຫຼື​ຮາດ​ແວ​. ບໍ່ມີພາກສ່ວນໃດນຶ່ງຂອງເອກະສານນີ້ສາມາດໄດ້ຮັບການຜະລິດຄືນ ຫຼືສົ່ງຕໍ່ໃນຮູບແບບໃດນຶ່ງ ຫຼືໂດຍວິທີໃດກໍ່ຕາມ - ເອເລັກໂຕຣນິກ ຫຼືກົນຈັກ - ສໍາລັບຈຸດປະສົງໃດໆໂດຍບໍ່ມີການອະນຸຍາດເປັນລາຍລັກອັກສອນຈາກ Algo.
ສໍາລັບຂໍ້ມູນເພີ່ມເຕີມຫຼືການຊ່ວຍເຫຼືອດ້ານວິຊາການໃນອາເມລິກາເຫນືອ, ກະລຸນາຕິດຕໍ່ທີມງານຊ່ວຍເຫຼືອຂອງ Algo:

ສະຫນັບສະຫນູນດ້ານວິຊາການ Algo
1-604-454-3792
support@algosolutions.com

©2022 Algo ເປັນເຄື່ອງໝາຍການຄ້າທີ່ຈົດທະບຽນຂອງ Algo Communication Products Ltd.
ສະຫງວນລິຂະສິດທັງໝົດ. ເຄື່ອງຫມາຍການຄ້າອື່ນໆທັງຫມົດແມ່ນຊັບສິນຂອງເຈົ້າຂອງຂອງເຂົາເຈົ້າ. ສະເປັກທັງໝົດແມ່ນມີການປ່ຽນແປງໂດຍບໍ່ຕ້ອງແຈ້ງໃຫ້ຮູ້ລ່ວງໜ້າ.

 ທົ່ວໄປ

ແນະນຳ

ເອກະສານນີ້ອະທິບາຍວິທີ Algo RESTful API ສາມາດໃຊ້ເພື່ອເຂົ້າເຖິງ, ຈັດການ ແລະກະຕຸ້ນການກະທຳຂອງ Algo IP Endpoints ໃນເຄືອຂ່າຍຂອງທ່ານຜ່ານຄຳຮ້ອງຂໍ HTTP/HTTPS, ເຊັ່ນດຽວກັນກັບວິທີການພິສູດຢືນຢັນສອງຢ່າງທີ່ມີລະດັບຄວາມປອດໄພແຕກຕ່າງກັນ. ລະບົບການຮ້ອງຂໍສາມາດໂຕ້ຕອບກັບອຸປະກອນ Algo ຜ່ານຊຸດປະຕິບັດການທີ່ບໍ່ເປັນລັດທີ່ກໍານົດໄວ້ລ່ວງໜ້າ ແລະເປັນເອກະພາບໃນເອກະສານນີ້. ການຮ້ອງຂໍແມ່ນເຮັດກັບ URI ຂອງຊັບພະຍາກອນທີ່ມີ payload JSON ແລະ elicit ຕອບສະຫນອງ JSON. HTTP/HTTPS GET, POST, ແລະ PUT ຄໍາຮ້ອງຂໍແມ່ນເຮັດກັບຊັບພະຍາກອນ URI ພ້ອມກັບ JSON payload (ເບິ່ງຄໍາສັ່ງສໍາລັບບັນຊີລາຍຊື່ຂອງ payloads).

 ການຢືນຢັນ

ມີສາມປະເພດຂອງການກວດສອບຄວາມຖືກຕ້ອງ:

•  ມາດຕະຖານ (ແນະນໍາ)
•  ພື້ນຖານ
•  ບໍ່ມີ (ບໍ່ແນະນຳ)

ການພິສູດຢືນຢັນມາດຕະຖານໃຊ້ລະຫັດຢືນຢັນຂໍ້ຄວາມທີ່ອີງໃສ່ Hash (HMAC) ດ້ວຍການຍ່ອຍສະຫຼາຍເຂົ້າລະຫັດ SHA-256. ການພິສູດຢືນຢັນພື້ນຖານໃຊ້ການເຂົ້າລະຫັດ Base64 ແລະຄວນໃຊ້ຜ່ານ HTTPS ເທົ່ານັ້ນ. ບໍ່ມີການກວດສອບຄວາມຖືກຕ້ອງຄວນຖືກໃຊ້ພຽງແຕ່ດ້ວຍຄວາມລະມັດລະວັງທີ່ສຸດເພາະມັນບໍ່ມີການກວດສອບຄວາມຖືກຕ້ອງ. ເບິ່ງພາກສ່ວນຄວາມຕ້ອງການການຮັບຮອງຄວາມຖືກຕ້ອງສໍາລັບລາຍລະອຽດເພີ່ມເຕີມ.

ການ​ຕັ້ງ​ຄ່າ​ແລະ​ການ​ຕັ້ງ​ຄ່າ​

ເງື່ອນໄຂເບື້ອງຕົ້ນ

•  ເອກະສານນີ້ຖືວ່າຈຸດສິ້ນສຸດຂອງ Algo ກໍາລັງແລ່ນເຟີມແວເວີຊັ່ນ 3.3 ຫຼືສູງກວ່າ.
•  ຄວາມແຕກຕ່າງຂອງເວລາລະຫວ່າງຜູ້ຮ້ອງຂໍ ແລະອຸປະກອນ Algo ຄວນມີໜ້ອຍກວ່າ 30 ວິນາທີເພື່ອໃຊ້ການພິສູດຢືນຢັນມາດຕະຖານ.
• ໃຫ້ແນ່ໃຈວ່າ NTP (Network Time Protocol) ຖືກໃຊ້ຢູ່. ທີ່ຢູ່ຂອງເຊີບເວີ NTP ແບບກຳນົດເອງອາດຈະຖືກຕັ້ງຄ່າໃນການຕັ້ງຄ່າຂັ້ນສູງ → ແຖບເວລາ.

ໝາຍເຫດ
ເຊີບເວີ NTP ທີ່ໄດ້ກຳນົດຄ່າໄວ້ລ່ວງໜ້າແມ່ນຖືກໂຮດໂດຍສາທາລະນະ, ດັ່ງນັ້ນການເຊື່ອມຕໍ່ອິນເຕີເນັດຈຶ່ງຈຳເປັນຕ້ອງເຂົ້າເຖິງມັນ. ຖ້າບໍ່ມີການເຊື່ອມຕໍ່ອິນເຕີເນັດ, ໃຫ້ຕັ້ງຄ່າເຊີບເວີ NTP ທ້ອງຖິ່ນ ແລະໃສ່ທີ່ຢູ່ IP ຂອງມັນ.

• ໃຫ້ແນ່ໃຈວ່າລະບົບອຸປະກອນ Algo ຖືກປັບເປັນເຂດເວລາທີ່ຖືກຕ້ອງ. ອັນນີ້ສາມາດເຮັດໄດ້ໂດຍການໄປທີ່ການຕັ້ງຄ່າຂັ້ນສູງ → ແຖບເວລາ.

 ເປີດໃຊ້ RESTful API

1. ເຂົ້າ​ສູ່​ລະ​ບົບ web ການໂຕ້ຕອບ ແລະນໍາທາງໄປຫາ Advanced Settings → Admin tab.
2. ເລື່ອນລົງໄປຫາພາກສ່ວນສະຫນັບສະຫນູນ API, ເປີດໃຊ້ RESTful API ແລະຕັ້ງລະຫັດຜ່ານຕາມທີ່ຕ້ອງການ (ລະຫັດຜ່ານທີ່ຜິດປົກກະຕິ: algo)
   ໝາຍເຫດ
   ການພິສູດຢືນຢັນມາດຕະຖານຖືກເປີດໃຊ້ໂດຍຄ່າເລີ່ມຕົ້ນ.

ເປີດໃຊ້ການພິສູດຢືນຢັນພື້ນຖານ (ທາງເລືອກ)

1. ໃນ web ອິນເຕີເຟດ, ໄປຫາລະບົບ → ແຖບການບຳລຸງຮັກສາ ແລະດາວໂຫຼດການຕັ້ງຄ່າ file.
2. ເປີດການຕັ້ງຄ່າ file ກັບຕົວແກ້ໄຂຂໍ້ຄວາມໃດນຶ່ງ ແລະເພີ່ມແຖວຕໍ່ໄປນີ້: api.auth.basic = 1
3.  ບັນທຶກ ແລະອັບໂຫລດການຕັ້ງຄ່າທີ່ປ່ຽນແປງ file ກັບໄປທີ່ອຸປະກອນໂດຍໃຊ້ Restore Configuration File ຄຸນສົມບັດໃນແຖບລະບົບ → ການບຳລຸງຮັກສາ.

ບໍ່ມີວິທີການກວດສອບຄວາມຖືກຕ້ອງ (ທາງເລືອກ)

ເພື່ອເປີດໃຊ້ວິທີການທີ່ບໍ່ມີການພິສູດຢືນຢັນ, ໃຫ້ຊ່ອງຂໍ້ມູນ RESTful API Password ຫວ່າງເປົ່າ. ວິທີການນີ້ບໍ່ໄດ້ຖືກແນະນໍາແລະຄວນຈະຖືກນໍາໃຊ້ເພື່ອຈຸດປະສົງການທົດສອບເທົ່ານັ້ນຍ້ອນວ່າມັນບໍ່ສະຫນອງຄວາມປອດໄພ.

ເປີດໃຊ້ການໂຕ້ຕອບການຄວບຄຸມແບບງ່າຍດາຍ (ທາງເລືອກ)

1. ສຸດ web ອິນເຕີເຟດ, ໄປຫາລະບົບ → ແຖບການບຳລຸງຮັກສາ ແລະດາວໂຫຼດການຕັ້ງຄ່າ file.
2.  ເປີດການຕັ້ງຄ່າ file ໃຊ້ຕົວແກ້ໄຂຂໍ້ຄວາມແລະເພີ່ມສອງແຖວ. ປ່ຽນ ກັບ​ລະ​ຫັດ​ຜ່ານ​ຄວາມ​ຕ້ອງ​ການ​ຂອງ​ທ່ານ​. ບໍລິຫານ.web.sci = 1
   Sci.admin.pwd =
3.  ບັນທຶກ ແລະອັບໂຫລດການຕັ້ງຄ່າທີ່ປ່ຽນແປງ file ກັບໄປທີ່ອຸປະກອນໂດຍໃຊ້ Restore Configuration File ຄຸນສົມບັດໃນແຖບລະບົບ → ການບຳລຸງຮັກສາ.

ຄວາມຕ້ອງການການກວດສອບຄວາມຖືກຕ້ອງ

ກະລຸນາສົ່ງອີເມວ support@algosolutions.com ຖ້າ​ຫາກ​ວ່າ​ທ່ານ​ຕ້ອງ​ການ​ມາດ​ຕະ​ຖານ​ຫຼື​ການ​ກວດ​ສອບ​ຂັ້ນ​ພື້ນ​ຖານ sampລະຫັດ le.

ການຮ້ອງຂໍການກວດສອບມາດຕະຖານດ້ວຍ JSON Payload

ສ່ວນຫົວທີ່ຕ້ອງການໃນຄໍາຮ້ອງຂໍ HTTP/HTTPS
> ປະເພດເນື້ອຫາ: “application/json”
> Content-MD5: [content_md5] Example
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]:[ເວລາສຸດamp]:[ບໍ່​ແມ່ນ]

ການປ້ອນຂໍ້ມູນ HMAC example: (ໃຊ້ 'algo' ເປັນກະແຈລັບ)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 ສ້າງ HMAC ດ້ວຍລະຫັດຜ່ານ ແລະສະຕຣິງປ້ອນ HMAC ເປັນການຍ່ອຍສະຫຼາຍໂດຍໃຊ້ SHA-256:
ຜົນ​ຜະ​ລິດ HMAC example: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

ວັນທີ: ມື້, ວັນທີເດືອນ, ປີ hr:min:sec GMT
Example
ວັນທີ: ພະຫັດ, 22 ກັນຍາ, 2022 02:33:07 GMT
ການກວດສອບມາດຕະຖານດ້ວຍ payload example:

 ການຮ້ອງຂໍການກວດສອບມາດຕະຖານໂດຍບໍ່ມີການ JSON Payload

ຄ້າຍຄືກັນກັບ 3.1 ທີ່ມີເນື້ອໃນທີ່ກ່ຽວຂ້ອງກັບສ່ວນຫົວ/hmac input ຖືກລະເວັ້ນ.
ການປ້ອນຂໍ້ມູນ HMAC: [request_method]:[request_uri]:[ເວລາສຸດamp]:[nonce] HMAC input example: (ໃຊ້ 'algo' ເປັນກະແຈລັບ)
ໄດ້ຮັບ:/api/settings/audio.page.vol:1601312252:49936
ສ້າງ HMAC ດ້ວຍລະຫັດຜ່ານ ແລະສະຕຣິງປ້ອນ HMAC ໂດຍໃຊ້ SHA-256:
ຜົນ​ຜະ​ລິດ HMAC example: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
ການກວດສອບມາດຕະຖານໂດຍບໍ່ມີການ payload example:

 ການຮ້ອງຂໍການຢັ້ງຢືນພື້ນຖານ

ວິທີການກວດສອບຄວາມຖືກຕ້ອງນີ້ຄວນຈະຖືກໃຊ້ດ້ວຍຄວາມລະມັດລະວັງຍ້ອນວ່າມັນມີຄວາມປອດໄພຫນ້ອຍກວ່າວິທີການມາດຕະຖານ.

ການອະນຸຍາດ: ພື້ນຖານ [base64]
Example:
ການອະນຸຍາດ: ພື້ນຖານ YWRtaW46YWxnbwo=
ການພິສູດຢືນຢັນພື້ນຖານ example:

ຄໍາສັ່ງ

 RESTful API ຄໍາສັ່ງ

ຂ້າງລຸ່ມນີ້ແມ່ນບັນຊີລາຍຊື່ຂອງຄໍາສັ່ງ API ສະຫນັບສະຫນູນທັງຫມົດ.

ໝາຍເຫດ
ຄໍາຮ້ອງຂໍ PUT ປ່ຽນແປງຫຼືສ້າງຊັບພະຍາກອນຖາວອນທີ່ລອດຊີວິດຈາກການປິດເປີດໃຫມ່, ໃນຂະນະທີ່ຄໍາຮ້ອງຂໍ POST ພຽງແຕ່ຄວບຄຸມອຸປະກອນສໍາລັບຊ່ວງເວລາປະຈຸບັນ.

ລາຍລະອຽດ	ວິທີການ	URI	ໂຫຼດ ພາລາມິເຕີ	ກັບຄືນ Example	ຜະລິດຕະພັນ	FW
ດຶງເອົາຄ່າຂອງຕົວກໍານົດການສະເພາະ.	ໄດ້ຮັບ	/api/settings/[key-name] Ex./api/settings/audio.page.vol	ບໍ່ມີ	{“audio.page.vol”: “-18dB”}	ທັງໝົດ	> 3.3
ສົ່ງຄືນລະດັບສຽງລົບກວນທີ່ວັດແທກເປັນ decibels. ຕ້ອງເປີດໃຊ້ການຊົດເຊີຍສິ່ງລົບກວນສະພາບແວດລ້ອມໃນການຕັ້ງຄ່າພື້ນຖານ -> ແຖບຄຸນສົມບັດ.	ໄດ້ຮັບ	/api/info/audio.noise.level	ບໍ່ມີ	{“audio.noise.level”: 72}	ລໍາໂພງສະແດງລໍາໂພງ	> 3.3
ສະກັດສະຖານະຂອງ relay input terminal.	ໄດ້ຮັບ	/api/info/input.relay.status	ບໍ່ມີ	{“input.relay.status”: “idle”} ຫຼື {“input.relay.status”: “active”}	ຜະລິດຕະພັນທັງຫມົດທີ່ມີການປ້ອນ Relay, ຍົກເວັ້ນ 8063. ເບິ່ງຂ້າງລຸ່ມນີ້.	> 4.1
ສະກັດສະຖານະຂອງ Input 1 ຫຼື Input 2 terminals.	ໄດ້ຮັບ	/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: {ສີຟ້າ, ສີແດງ, ອໍາພັນ, ສີຂຽວ} color2: {ສີຟ້າ, ສີແດງ, ອໍາພັນ, ສີຂຽວ} ledlvl: {1 – 255} ການຄອບຄອງ: {true, false}	ບໍ່ມີ	8128(G2) 8138 8190S	> 3.3
ຢຸດ strobe ໄດ້.	ໂພສ	/api/controls/strobe/stop	ບໍ່ມີ	ບໍ່ມີ	8128(G2) 8138 8190S	> 3.3
ຫຼິ້ນສຽງຄັ້ງດຽວ ຫຼື ໝູນມັນ.	ໂພສ	/api/controls/tone/start	ເສັ້ນທາງ: {tone} ie. chime.wav loop: {true, false} ຫຼື {0, 1} ຕົວຢ່າງ: {“ເສັ້ນທາງ”:”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
ປົດລັອກປະຕູ. "ທ້ອງຖິ່ນ" ຄວບຄຸມ relay ທ້ອງຖິ່ນ "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
ເປີດໃຊ້ 24v aux out relay.	ໂພສ	api/controls/24v/ເປີດໃຊ້ງານ	ບໍ່ມີ	ບໍ່ມີ	8063	> 5.0
ປິດການໃຊ້ງານ 24v aux out relay.	ໂພສ	api/controls/24v/ປິດການໃຊ້ງານ	ບໍ່ມີ	ບໍ່ມີ	8063	> 5.0
ເປີດໃຊ້ relay ອອກ.	ໂພສ	/api/controls/relay/enable	ບໍ່ມີ	ບໍ່ມີ	8063	> 5.0
ປິດການໃຊ້ງານ relay ອອກ.	ໂພສ	/api/controls/relay/ປິດການໃຊ້ງານ	ບໍ່ມີ	ບໍ່ມີ	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/reload	ບໍ່ມີ	ບໍ່ມີ	ທັງໝົດ	> 5.3.4
ເລີ່ມຟັງການຖ່າຍທອດສຽງໂດຍກົງ. ກຳນົດຄ່າໝາຍເລກພອດທີ່ກະແສກຳລັງຖືກສົ່ງ.	ໂພສ	/api/controls/rx/start	{“ພອດ”: }	ບໍ່ມີ	ທັງໝົດ	> 5.3.4
ຢຸດຟັງການຖ່າຍທອດສຽງໂດຍກົງ.	ໂພສ	/api/controls/rx/stop	ບໍ່ມີ	ບໍ່ມີ	ທັງໝົດ	> 5.3.4
ຕັ້ງໂຫມດ multicast.	ວາງ	/api/state/mcast/update/	{“mode”:”sender”, “ທີ່ຢູ່”: , "ພອດ": , “type”:”rtp”} ຫຼື {“mode”:”sender”, “address”: , "ພອດ": , “type”:”poly”, “group”:1} ** ຫມາຍ​ເຫດ**​: ຖ້າ​ຫາກ​ວ່າ​ການ​ຄວບ​ຄຸມ / tone / start ຖືກ​ນໍາ​ໃຊ້​ກ່ອນ​ທີ່​ຈະ​ຄໍາ​ສັ່ງ​ນີ້​, ສຽງ​ຈະ​ຫຼິ້ນ​ໂດຍ​ການ​ນໍາ​ໃຊ້​ການ​ຕັ້ງ​ຄ່າ​ໃນ​ປະ​ຈຸ​ບັນ​ໃນ​. web UI	ບໍ່ມີ	8301	> 5.0
ໃສ່ຄ່າໃສ່ພາລາມິເຕີສະເພາະຈາກ JSON payload.	ວາງ	/api/ການຕັ້ງຄ່າ	ພາຣາມິເຕີ: {value} ຕົວຢ່າງ: {“audio.page.vol”: “-3dB”}	ບໍ່ມີ	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Simple Control Interface (SCI) ຄໍາສັ່ງ

ຄໍາສັ່ງ SCI ທັງຫມົດແມ່ນການຮ້ອງຂໍ GET ແລະມີຕົວກໍານົດການທົ່ວໄປ "usi" ແລະ "admin" ສໍາລັບການກວດສອບຄວາມຖືກຕ້ອງ.
Example:
ເອົາ http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

ລາຍລະອຽດ	URI	ເພີ່ມເຕີມ ໂຫຼດ ພາລາມິເຕີ	ຜະລິດຕະພັນ	FW
ປົດລັອກປະຕູ. "ທ້ອງຖິ່ນ" ຄວບຄຸມ relay ທ້ອງຖິ່ນ "netdc1" ຄວບຄຸມຕົວຄວບຄຸມປະຕູເຄືອຂ່າຍຫ່າງໄກສອກຫຼີກ (8063)	/sci/controls/do ຫຼື/unlock	doorid: {local, netdc1} * ທາງເລືອກ	8039 8028(G2) 8201 8063	> 3.3
ລັອກປະຕູ.	/sci/controls/do ຫຼື/lock	doorid: {local, netdc1} * ທາງເລືອກ	8039 8028(G2) 8201 8063	> 3.3
ຫຼິ້ນສຽງຄັ້ງດຽວ ຫຼື ໝູນມັນ.	/sci/controls/to ne/start	ເສັ້ນທາງ: {tone} ie. chime.wav loop: {true, false} ຫຼື {0, 1}	ທັງໝົດ	> 3.3
ຢຸດສຽງ.	/sci/controls/to ne/stop	ບໍ່ມີ	ທັງໝົດ	> 3.3
ເປີດໃຊ້ strobe ດ້ວຍສີທີ່ຕ້ອງການແລະຕົວກໍານົດການຮູບແບບ.	/sci/controls/strobe/start	ຮູບແບບ: {0 – 15} color1: {ສີຟ້າ, ສີແດງ, ອໍາພັນ, ສີຂຽວ} color2: {ສີຟ້າ, ສີແດງ, ອໍາພັນ, ສີຂຽວ} ledlvl: {1 – 255} ການຄອບຄອງ: {true, false}	8128(G2) 8138 8190S	> 3.3
ຢຸດ strobe ໄດ້.	/sci/controls/strobe/stop	ບໍ່ມີ	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

ເອກະສານອ້າງອີງ

• ຄູ່ມືຜູ້ໃຊ້