เนื้อหา ซ่อน

โลโก้ ALGO RESTful API

ALGO RESTful API

ผลิตภัณฑ์ ALGO RESTful API

ข้อมูลผลิตภัณฑ์: คู่มือ RESTful API

Algo RESTful API อนุญาตให้ผู้ใช้เข้าถึง จัดการ และทริกเกอร์การดำเนินการบนตำแหน่งข้อมูล IP ของ Algo บนเครือข่ายผ่านคำขอ HTTP/HTTPS เอกสารนี้ให้ชุดการดำเนินการไร้สัญชาติที่สม่ำเสมอและกำหนดไว้ล่วงหน้า ซึ่งสามารถใช้เพื่อโต้ตอบกับอุปกรณ์ Algo API รองรับคำขอ HTTP/HTTPS GET, POST และ PUT พร้อมเพย์โหลด JSON

การรับรองความถูกต้อง

การตรวจสอบสิทธิ์ที่ใช้ได้กับ Algo RESTful API มีสามประเภท:

  • การรับรองความถูกต้องมาตรฐาน (เปิดใช้งานโดยค่าเริ่มต้น)
  • การรับรองความถูกต้องพื้นฐาน (ไม่บังคับ)
  • ไม่มีวิธีการรับรองความถูกต้อง (ไม่แนะนำ สำหรับวัตถุประสงค์ในการทดสอบเท่านั้น)

คำแนะนำการใช้ผลิตภัณฑ์: RESTful API

ข้อกำหนดเบื้องต้น

ก่อนที่จะเปิดใช้งาน RESTful API ตรวจสอบให้แน่ใจว่าอุปกรณ์มีการเชื่อมต่ออินเทอร์เน็ตเพื่อเข้าถึงเซิร์ฟเวอร์ NTP ที่กำหนดค่าไว้ล่วงหน้า หากไม่มีการเชื่อมต่ออินเทอร์เน็ต ให้กำหนดค่าเซิร์ฟเวอร์ NTP ในเครื่องและป้อนที่อยู่ IP

เปิดใช้งาน RESTful API
  1. เข้าสู่ระบบของอุปกรณ์ web อินเทอร์เฟซและไปที่แท็บผู้ดูแลระบบการตั้งค่าขั้นสูง
  2. เลื่อนลงไปที่ส่วนการสนับสนุน API และเปิดใช้งาน RESTful API
  3. ตั้งรหัสผ่านที่ต้องการ (รหัสผ่านเริ่มต้น: algo) โปรดทราบว่าการรับรองความถูกต้องมาตรฐานจะเปิดใช้งานตามค่าเริ่มต้น
เปิดใช้งานการรับรองความถูกต้องพื้นฐาน (ไม่บังคับ)
  1. ใน web ไปที่แท็บ System Maintenance และดาวน์โหลดการกำหนดค่า file.
  2. เปิดการกำหนดค่า file ด้วยโปรแกรมแก้ไขข้อความและเพิ่มบรรทัดต่อไปนี้: api.auth.basic = 1
  3. บันทึกและอัปโหลดการกำหนดค่าที่แก้ไข file กลับไปที่อุปกรณ์โดยใช้การคืนค่าการกำหนดค่า File คุณลักษณะในแท็บการบำรุงรักษาระบบ
การเปิดใช้งานไม่มีวิธีการรับรองความถูกต้อง (ไม่บังคับ)

หากต้องการเปิดใช้งานวิธีการไม่ตรวจสอบสิทธิ์ ให้เว้นฟิลด์ RESTful API Password ว่างไว้ ไม่แนะนำให้ใช้วิธีนี้และควรใช้เพื่อจุดประสงค์ในการทดสอบเท่านั้นเนื่องจากไม่มีความปลอดภัย

การเปิดใช้งานส่วนต่อประสานการควบคุมอย่างง่าย (ทางเลือก)
  1. บน web ไปที่แท็บ System Maintenance และดาวน์โหลดการกำหนดค่า file.
  2. เปิดการกำหนดค่า file ใช้โปรแกรมแก้ไขข้อความและเพิ่มสองบรรทัด เปลี่ยนรหัสผ่านที่คุณต้องการ
  3. ผู้ดูแลระบบweb.วิทย์ = 1
  4. Sci.admin.pwd=
  5. บันทึกและอัปโหลดการกำหนดค่าที่แก้ไข file กลับไปที่อุปกรณ์โดยใช้การคืนค่าการกำหนดค่า File คุณลักษณะในแท็บการบำรุงรักษาระบบ

การรับรองความถูกต้อง Sampรหัส

กรุณาอีเมล์ 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.
สงวนลิขสิทธิ์. เครื่องหมายการค้าอื่นๆ ทั้งหมดเป็นทรัพย์สินของเจ้าของที่เกี่ยวข้อง ข้อมูลจำเพาะทั้งหมดอาจเปลี่ยนแปลงได้โดยไม่ต้องแจ้งให้ทราบล่วงหน้า

 ทั่วไป

การแนะนำ

เอกสารนี้อธิบายวิธีที่ Algo RESTful API สามารถใช้เพื่อเข้าถึง จัดการ และทริกเกอร์การดำเนินการบนตำแหน่งข้อมูล IP ของ Algo บนเครือข่ายของคุณผ่านคำขอ HTTP/HTTPS รวมถึงวิธีการตรวจสอบสิทธิ์ที่แตกต่างกันสองสามวิธีซึ่งมีระดับความปลอดภัยที่แตกต่างกัน ระบบที่ร้องขอสามารถโต้ตอบกับอุปกรณ์ Algo ผ่านชุดการดำเนินการไร้สัญชาติที่สม่ำเสมอและกำหนดไว้ล่วงหน้าตามที่กำหนดไว้ในเอกสารนี้ คำขอจะถูกส่งไปยัง URI ของทรัพยากรด้วยเพย์โหลด JSON และล้วงเอาการตอบสนอง JSON คำขอ HTTP/HTTPS GET, POST และ PUT ถูกสร้างขึ้นไปยัง URI ทรัพยากรพร้อมกับเพย์โหลด JSON (ดูส่วนคำสั่งสำหรับรายการเพย์โหลด)

 การรับรองความถูกต้อง

การรับรองความถูกต้องมีสามประเภท:

  •  มาตรฐาน (แนะนำ)
  •  พื้นฐาน
  •  ไม่มี (ไม่แนะนำ)

การรับรองความถูกต้องแบบมาตรฐานใช้รหัสรับรองความถูกต้องข้อความแบบแฮช (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)
    บันทึก
    การรับรองความถูกต้องมาตรฐานจะเปิดใช้งานตามค่าเริ่มต้นอัลโก RESTful API 01
เปิดใช้งานการรับรองความถูกต้องขั้นพื้นฐาน (ไม่บังคับ)
  1. ใน web นำทางไปยังแท็บระบบ → การบำรุงรักษา และดาวน์โหลดการกำหนดค่า file.
  2. เปิดการกำหนดค่า file ด้วยโปรแกรมแก้ไขข้อความและเพิ่มบรรทัดต่อไปนี้: api.auth.basic = 1
  3.  บันทึกและอัปโหลดการกำหนดค่าที่แก้ไข file กลับไปที่อุปกรณ์โดยใช้การคืนค่าการกำหนดค่า File คุณสมบัติในแท็บระบบ → การบำรุงรักษา
ไม่มีวิธีการรับรองความถูกต้อง (ทางเลือก)

หากต้องการเปิดใช้งานวิธีการไม่ตรวจสอบสิทธิ์ ให้เว้นฟิลด์ RESTful API Password ว่างไว้ ไม่แนะนำให้ใช้วิธีนี้และควรใช้เพื่อจุดประสงค์ในการทดสอบเท่านั้นเนื่องจากไม่มีความปลอดภัย

การเปิดใช้งานส่วนต่อประสานการควบคุมอย่างง่าย (ทางเลือก)
  1. บน web นำทางไปยังแท็บระบบ → การบำรุงรักษา และดาวน์โหลดการกำหนดค่า file.
  2.  เปิดการกำหนดค่า file ใช้โปรแกรมแก้ไขข้อความและเพิ่มสองบรรทัด เปลี่ยน ตามรหัสผ่านที่คุณต้องการ ผู้ดูแลระบบweb.วิทย์ = 1
    Sci.admin.pwd=
  3.  บันทึกและอัปโหลดการกำหนดค่าที่แก้ไข file กลับไปที่อุปกรณ์โดยใช้การคืนค่าการกำหนดค่า File คุณสมบัติในแท็บระบบ → การบำรุงรักษา

ข้อกำหนดในการตรวจสอบสิทธิ์

กรุณาอีเมล์ support@algosolutions.com หากคุณต้องการการรับรองความถูกต้องแบบมาตรฐานหรือขั้นพื้นฐานampรหัส

คำขอการรับรองความถูกต้องมาตรฐานด้วย JSON Payload

ส่วนหัวที่จำเป็นในคำขอ HTTP/HTTPS
> ประเภทเนื้อหา: “application/json”
> Content-MD5: [content_md5] เช่นample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

การอนุญาต: ผู้ดูแลระบบ hmac: [nonce]: [hmac_output]
ส่วนหัวของการอนุญาตประกอบด้วย:

  1. สตริง 'hmac admin' ตามด้วยโคลอน ':'
  2. Nonce – ค่าสุ่มหรือไม่ซ้ำ ตามด้วยโคลอน ':'
  3. Hmac_output – สร้างโดยรหัสผ่าน RESTful API (คีย์ลับ) ที่กำหนดค่าบนอุปกรณ์ของคุณและอินพุต HMAC ตามด้านล่าง:
    [request_method]:[request_uri]:[content_md5]:[content_type]:[เวลาamp]:[ไม่มี]

อินพุต HMAC เช่นample: (ใช้ 'algo' เป็นรหัสลับ)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 สร้าง HMAC ด้วยรหัสผ่านและสตริงอินพุต HMAC เป็นการย่อยโดยใช้ SHA-256:
เอาต์พุต HMAC เช่นample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

วันที่: วัน, วันที่เดือน, ปี hr:min:sec GMT
Example
วันที่: พฤหัสบดี 22 กันยายน 2022 02:33:07 GMT
การรับรองความถูกต้องมาตรฐานด้วยเพย์โหลด เช่นampเลอ:

อัลโก RESTful API 02

 คำขอการรับรองความถูกต้องมาตรฐานโดยไม่มีเพย์โหลด JSON

เหมือนกับ 3.1 โดยละเว้นส่วนหัว/อินพุต hmac ที่เกี่ยวข้องกับเนื้อหา
อินพุต HMAC: [request_method]:[request_uri]:[timestamp]:[ไม่มี] อินพุต HMAC เช่นample: (ใช้ 'algo' เป็นรหัสลับ)
ได้รับ:/api/settings/audio.page.vol:1601312252:49936
สร้าง HMAC ด้วยรหัสผ่านและสตริงอินพุต HMAC โดยใช้ SHA-256:
เอาต์พุต HMAC เช่นample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
การรับรองความถูกต้องมาตรฐานโดยไม่มีเพย์โหลด เช่นampเลอ:

อัลโก RESTful API 03

 คำขอการรับรองความถูกต้องขั้นพื้นฐาน

วิธีการรับรองความถูกต้องนี้ควรใช้ด้วยความระมัดระวัง เนื่องจากมีความปลอดภัยน้อยกว่าวิธีมาตรฐาน

การอนุญาต: พื้นฐาน [base64]
Exampเลอ:
การอนุญาต: พื้นฐาน YWRtaW46YWxnbwo=
การรับรองความถูกต้องขั้นพื้นฐาน เช่นampเลอ:
อัลโก RESTful API 04

คำสั่ง

 คำสั่ง RESTful API

ด้านล่างนี้คือรายการคำสั่ง API ที่รองรับทั้งหมด

บันทึก
คำขอ PUT จะเปลี่ยนแปลงหรือสร้างทรัพยากรถาวรที่สามารถรีบูตได้ ในขณะที่คำขอ POST จะควบคุมเฉพาะอุปกรณ์สำหรับเซสชันปัจจุบันเท่านั้น

คำอธิบาย วิธี ยูอาร์ไอ บรรทุกสินค้า พารามิเตอร์ กลับ Example ผลิตภัณฑ์ FW
ดึงค่าของพารามิเตอร์เฉพาะ  รับ /api/settings/[ชื่อคีย์] เช่น/api/settings/audio.page.vol  ไม่มีข้อมูล  {“audio.page.vol”: “-18dB”}  ทั้งหมด  > 3.3
ส่งกลับระดับเสียงรบกวนรอบข้างที่วัดเป็นเดซิเบล ต้องเปิดใช้งานการชดเชยเสียงรบกวนรอบข้างในการตั้งค่าพื้นฐาน -> แท็บคุณสมบัติ รับ /api/info/audio.noise.level ไม่มีข้อมูล {“เสียง.noise.level”: 72}  ลำโพง จอแสดงผล ลำโพง > 3.3
 แยกสถานะของเทอร์มินัลอินพุตรีเลย์ รับ /api/info/input.relay.status ไม่มีข้อมูล  

{“input.relay.status”: “ไม่ได้ใช้งาน”} หรือ {“input.relay.status”: “ใช้งานอยู่”}

ผลิตภัณฑ์ทั้งหมดที่มีอินพุตรีเลย์ ยกเว้น 8063 ดูด้านล่าง > 4.1
 แยกสถานะของขั้วต่ออินพุต 1 หรืออินพุต 2  รับ /api/info/input.relay1.status หรือ /api/info/input.relay2.status  ไม่มีข้อมูล {“input.relay1.status”: “ไม่ได้ใช้งาน”} หรือ {“input.relay1.status”: “ใช้งานอยู่”}  8063  > 4.1
ดึงรายการของเสียง fileที่ติดตั้งอยู่ในขณะนี้  รับ  /api/info/tonelist  

ไม่มีข้อมูล

{“tonelist”:[“bell-na.wav”,”เบลล์ uk.wav”,”buzzer.wav”,…]}  ทั้งหมด  > 5.0
ดึงข้อมูลอุปกรณ์ที่แสดงบนหน้าสถานะ  รับ  /api/info/สถานะ  ไม่มีข้อมูล  รายการข้อมูลทั้งหมดจากแท็บสถานะ  ทั้งหมด  > 5.4
รับข้อมูลผลิตภัณฑ์ที่แสดงบนหน้าเกี่ยวกับ  รับ /api/ข้อมูล/เกี่ยวกับ  ไม่มีข้อมูล  ข้อมูลทั้งหมดแสดงอยู่ในแท็บเกี่ยวกับ ทั้งหมด > 5.4
เปิดใช้งานแฟลชด้วยพารามิเตอร์สีและรูปแบบที่ต้องการ โพสต์ /api/controls/strobe/เริ่ม รูปแบบ: {0 – 15}
color1: {น้ำเงิน แดง เหลืองอำพัน เขียว} color2: {น้ำเงิน แดง เหลืองอำพัน เขียว} ระดับ led: {1 – 255}
สิ่งที่ค้างอยู่: {จริง, เท็จ}
ไม่มีข้อมูล  8128(G2)
8138
8190วินาที
> 3.3
 หยุดไฟแฟลช  โพสต์  /api/controls/strobe/หยุด  ไม่มีข้อมูล  ไม่มีข้อมูล 8128(G2)
8138
8190วินาที
> 3.3
เล่นเสียงหนึ่งครั้งหรือวนซ้ำ โพสต์ /api/controls/tone/start เส้นทาง: {tone} เช่น 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”, “ช่วงเวลา”:”0″, “maxdur”:”10″}
ไม่มีข้อมูล ลำโพง 8301
8410
8420
> 3.3
วางสาย โพสต์ /api/controls/โทร/หยุด ไม่มีข้อมูล ไม่มีข้อมูล ลำโพง 8301
8410
8420
> 3.3
เริ่มต้นการโทรเพจทางเดียว อุปกรณ์จะรับสตรีมเสียงจากส่วนขยายเป้าหมาย  โพสต์  /api/controls/call/page  {"ส่วนขยาย":" ”}  ไม่มีข้อมูล ลำโพง 8410
8420
 > 5.3.4
รีบูตปลายทางเป้าหมาย โพสต์ /api/controls/reboot ไม่มีข้อมูล ไม่มีข้อมูล ทั้งหมด > 3.3
ปลดล็อคประตู “local” ควบคุมรีเลย์ในเครื่อง “netdc1” ควบคุมตัวควบคุมประตูเครือข่ายระยะไกล (8063) โพสต์ /api/controls/door/unlock ประตู: {ท้องถิ่น netdc1}
*ไม่จำเป็น
ไม่มีข้อมูล 8039
8028(G2)
8201
8063
> 3.3
ล็อคประตู. โพสต์ /api/controls/ประตู/ล็อค  ประตู: {ท้องถิ่น netdc1}
*ไม่จำเป็น
ไม่มีข้อมูล 8039
8028(G2)
8201
8063
> 3.3
เปิดใช้งานรีเลย์ 24v aux out โพสต์ API/การควบคุม/24V/เปิดใช้งาน ไม่มีข้อมูล ไม่มีข้อมูล 8063 > 5.0
ปิดการทำงานของรีเลย์ aux out 24v โพสต์ API/การควบคุม/24V/ปิดการใช้งาน ไม่มีข้อมูล ไม่มีข้อมูล 8063 > 5.0
เปิดใช้งานรีเลย์เอาท์พุต โพสต์ /api/controls/relay/enable ไม่มีข้อมูล ไม่มีข้อมูล 8063 > 5.0
ปิดการใช้งานรีเลย์เอาท์พุต โพสต์ /api/controls/relay/disable ไม่มีข้อมูล ไม่มีข้อมูล 8063 > 5.0
ตรวจสอบเซิร์ฟเวอร์เฟิร์มแวร์ของ Algo สำหรับเฟิร์มแวร์เวอร์ชันล่าสุด  โพสต์  /api/controls/อัปเกรด/ตรวจสอบ  ไม่มีข้อมูล {“รุ่น”: “อัปเดต”} หรือ
{“รุ่น”: “ ”}
 ทั้งหมด  > 4.1
 ตรวจสอบเซิร์ฟเวอร์เฟิร์มแวร์ของ Algo เพื่อดูเฟิร์มแวร์เวอร์ชันล่าสุดและอัปเกรดเป็นเวอร์ชันนั้น โพสต์ /api/controls/อัปเกรด/เริ่ม ไม่มีข้อมูล {“สถานะ”: “อัปเดต”} หรือ
{"สถานะ": "กำลังอัปเกรด ”, “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.php {"ท่าเรือ": } ไม่มีข้อมูล ทั้งหมด   > 5.3.4
หยุดฟังสตรีมเสียงโดยตรง โพสต์  /api/controls/rx/stop  ไม่มีข้อมูล  ไม่มีข้อมูล  ทั้งหมด  > 5.3.4
ตั้งค่าโหมดมัลติคาสต์ ใส่ /api/สถานะ/mcast/อัปเดต/ {“โหมด”:”ผู้ส่ง”, “ที่อยู่”: , "ท่าเรือ": , “ประเภท”:”rtp”} หรือ {“โหมด”:”ผู้ส่ง”, “ที่อยู่”: , "ท่าเรือ": , “ประเภท”:”โพลี”, “กลุ่ม”:1}
**หมายเหตุ**: หากใช้ controls/tone/start ก่อนคำสั่งนี้ เสียงจะเล่นโดยใช้การตั้งค่าปัจจุบันบน web UI
ไม่มีข้อมูล 8301 > 5.0
ใส่ค่าให้กับพารามิเตอร์เฉพาะจากเพย์โหลด JSON ใส่ /api/การตั้งค่า พารามิเตอร์: {value}
เช่น {“audio.page.vol”: “-3dB”}
ไม่มีข้อมูล 8180(G2)
8186
8190
8190วินาที
8301
8373
> 3.3
 คำสั่ง Simple Control Interface (SCI)

คำสั่ง SCI ทั้งหมดเป็นคำขอ GET และมีพารามิเตอร์ทั่วไปคือ “usi” และ “admin” สำหรับการรับรองความถูกต้อง
Exampเลอ:
รับ http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

 คำอธิบาย  ยูอาร์ไอ เพิ่มเติม บรรทุกสินค้า พารามิเตอร์ สินค้า  FW
ปลดล็อคประตู
“ท้องถิ่น” ควบคุมรีเลย์ท้องถิ่น “netdc1” ควบคุมตัวควบคุมประตูเครือข่ายระยะไกล (8063)
/sci/controls/do หรือ/unlock ประตู: {ท้องถิ่น netdc1}
*ไม่จำเป็น
8039
8028(G2)
8201
8063
> 3.3
ล็อคประตู. /sci/controls/do หรือ/lock ประตู: {ท้องถิ่น netdc1}
*ไม่จำเป็น
8039
8028(G2)
8201
8063
> 3.3
เล่นเสียงหนึ่งครั้งหรือวนซ้ำ  /sci/controls/ถึงไม่มี/เริ่ม เส้นทาง: {tone} เช่น chime.wav
วนซ้ำ: {จริง, เท็จ} หรือ {0, 1}
ทั้งหมด  > 3.3
หยุดเสียง /sci/controls/to ne/stop  ไม่มีข้อมูล  ทั้งหมด  > 3.3
เปิดใช้งานแฟลชด้วยพารามิเตอร์สีและรูปแบบที่ต้องการ /sci/controls/strobe/start รูปแบบ: {0 – 15} สี1: {น้ำเงิน แดง เหลืองอำพัน เขียว}
color2: {น้ำเงิน แดง เหลืองอำพัน เขียว}
ledlvl: {1 – 255} การถือครอง: {true, false}
8128(G2)
8138
8190วินาที
> 3.3
 หยุดไฟแฟลช  /sci/controls/strobe/stop  ไม่มีข้อมูล 8128(G2)
8138
8190วินาที
 > 3.3

เอกสาร / แหล่งข้อมูล

ALGO RESTful API [พีดีเอฟ] คู่มือการใช้งาน
AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, API สงบ, สงบ, API
ALGO RESTful API [พีดีเอฟ] คู่มือการใช้งาน
AL061-GU-CP000API-230717, สงบ API, สงบ, API

อ้างอิง

ฝากความคิดเห็น

ที่อยู่อีเมลของคุณจะไม่ถูกเผยแพร่ ช่องที่ต้องกรอกข้อมูลมีเครื่องหมาย *