API ALGO RESTful

Maklumat Produk: Panduan API RESTful

API RESTful Algo membolehkan pengguna mengakses, memanipulasi dan mencetuskan tindakan pada Titik Akhir IP Algo pada rangkaian mereka melalui permintaan HTTP/HTTPS. Dokumen ini menyediakan set operasi tanpa kewarganegaraan seragam dan pratakrif yang boleh digunakan untuk berinteraksi dengan peranti Algo. API menyokong permintaan HTTP/HTTPS GET, POST dan PUT dengan muatan JSON.

Pengesahan

Terdapat tiga jenis pengesahan yang tersedia dengan Algo RESTful API:

• Pengesahan standard (didayakan secara lalai)
• Pengesahan asas (pilihan)
• Tiada kaedah pengesahan (tidak disyorkan; hanya untuk tujuan ujian)

Arahan Penggunaan Produk: RESTful API

Prasyarat

Sebelum mendayakan API RESTful, pastikan peranti mempunyai sambungan Internet untuk mencapai pelayan NTP yang diprakonfigurasikan. Jika tiada sambungan internet tersedia, konfigurasikan pelayan NTP tempatan dan masukkan alamat IPnya.

Mendayakan API RESTful

1. Log masuk ke peranti web antara muka dan navigasi ke tab Pentadbir Tetapan Lanjutan.
2. Tatal ke bawah ke bahagian Sokongan API dan dayakan API RESTful.
3. Tetapkan kata laluan yang dikehendaki (kata laluan lalai: algo). Ambil perhatian bahawa pengesahan standard didayakan secara lalai.

Mendayakan Pengesahan Asas (Pilihan)

1. Dalam web antara muka, navigasi ke tab Penyelenggaraan Sistem dan muat turun konfigurasi file.
2. Buka konfigurasi file dengan mana-mana editor teks dan tambah baris berikut: api.auth.basic = 1
3. Simpan dan muat naik konfigurasi yang diubah suai file kembali ke peranti menggunakan Konfigurasi Pulihkan File ciri dalam tab Penyelenggaraan Sistem.

Mendayakan Kaedah Tiada Pengesahan (Pilihan)

Untuk mendayakan kaedah tanpa pengesahan, biarkan medan Kata Laluan API RESTful kosong. Kaedah ini tidak disyorkan dan hanya boleh digunakan untuk tujuan ujian sahaja kerana ia tidak memberikan keselamatan.

Mendayakan Antara Muka Kawalan Mudah (Pilihan)

1. pada web antara muka, navigasi ke tab Penyelenggaraan Sistem dan muat turun konfigurasi file.
2. Buka konfigurasi file menggunakan editor teks dan tambah dua baris. Tukar kata laluan kepada keinginan anda.
3. Admin.web.sci = 1
4. Sci.admin.pwd =
5. Simpan dan muat naik konfigurasi yang diubah suai file kembali ke peranti menggunakan Konfigurasi Pulihkan File ciri dalam tab Penyelenggaraan Sistem.

Pengesahan Sample Kod

Sila email sokongan@algosolutions.com jika anda mahukan pengesahan standard atau asas sampkod itu.
Untuk sokongan tambahan, hubungi 604-454-3792 atau e-mel sokongan@algosolutions.com

Notis Maklumat

Nota
Nota menunjukkan kemas kini berguna, maklumat dan arahan yang harus diikuti

Penafian

Maklumat yang terkandung dalam dokumen ini dipercayai tepat dalam semua aspek tetapi tidak dibenarkan oleh Algo. Maklumat ini tertakluk kepada perubahan tanpa notis dan tidak boleh ditafsirkan dalam apa-apa cara sebagai komitmen oleh Algo atau mana-mana sekutu atau anak syarikatnya. Algo dan sekutu serta anak syarikatnya tidak bertanggungjawab atas sebarang kesilapan atau ketinggalan dalam dokumen ini. Semakan dokumen ini atau edisi baharunya mungkin dikeluarkan untuk memasukkan perubahan tersebut. Algo tidak bertanggungjawab untuk kerosakan atau tuntutan akibat daripada sebarang penggunaan manual ini atau produk, perisian, perisian tegar dan/atau perkakasan sedemikian. Tiada bahagian daripada dokumen ini boleh diterbitkan semula atau dihantar dalam sebarang bentuk atau dengan sebarang cara – elektronik atau mekanikal – untuk sebarang tujuan tanpa kebenaran bertulis daripada Algo.
Untuk mendapatkan maklumat tambahan atau bantuan teknikal di Amerika Utara, sila hubungi pasukan sokongan Algo:

Sokongan Teknikal Algo
1-604-454-3792
sokongan@algosolutions.com

©2022 Algo ialah tanda dagangan berdaftar Algo Communication Products Ltd.
Hak cipta terpelihara. Semua tanda dagangan lain adalah hak milik pemilik masing-masing. Semua spesifikasi tertakluk kepada perubahan tanpa notis.

 UMUM

pengenalan

Dokumen ini menerangkan cara API Algo RESTful boleh digunakan untuk mengakses, memanipulasi dan mencetuskan tindakan pada Titik Akhir IP Algo pada rangkaian anda melalui permintaan HTTP/HTTPS, serta beberapa kaedah pengesahan yang berbeza dengan tahap keselamatan yang berbeza-beza. Sistem yang meminta boleh berinteraksi dengan peranti Algo melalui set operasi tanpa kewarganegaraan seragam dan pratakrif yang ditakrifkan dalam dokumen ini. Permintaan dibuat kepada URI sumber dengan muatan JSON dan mendapatkan respons JSON. Permintaan HTTP/HTTPS GET, POST dan PUT dibuat untuk sumber URI bersama-sama dengan muatan JSON (lihat bahagian arahan untuk senarai muatan).

 Pengesahan

Terdapat tiga jenis pengesahan:

•  Standard (disyorkan)
•  asas
•  Tiada (tidak disyorkan)

Pengesahan Standard menggunakan Kod Pengesahan Mesej berasaskan Hash (HMAC) dengan ringkasan berkod SHA-256. Pengesahan asas menggunakan pengekodan Base64 dan hanya boleh digunakan melalui HTTPS. Tiada pengesahan hanya boleh digunakan dengan berhati-hati kerana ia tidak memberikan pengesahan. Lihat bahagian Keperluan Pengesahan untuk mendapatkan butiran lanjut.

PENYEDIAAN DAN KONFIGURASI

Prasyarat

•  Dokumen ini menganggap titik akhir Algo menjalankan perisian tegar versi 3.3 atau lebih tinggi.
•  Perbezaan masa antara peminta dan peranti Algo hendaklah kurang daripada 30 saat untuk menggunakan pengesahan standard.
• Pastikan NTP (Protokol Masa Rangkaian) sedang digunakan. Alamat pelayan NTP tersuai mungkin dikonfigurasikan dalam tab Tetapan Lanjutan → Masa.

Nota
Pelayan NTP prakonfigurasi dihoskan secara umum, oleh itu sambungan internet diperlukan untuk mencapainya. Jika tiada sambungan internet tersedia, konfigurasikan pelayan NTP tempatan dan masukkan alamat IPnya.

• Pastikan masa sistem peranti Algo dilaraskan ke zon waktu yang betul. Ini boleh dilakukan dengan menavigasi ke Tetapan Lanjutan → tab Masa.

 Mendayakan API RESTful

1. Log masuk ke web antara muka dan navigasi ke Tetapan Lanjutan → tab Pentadbir.
2. Tatal ke bawah ke bahagian Sokongan API, dayakan API RESTful dan tetapkan Kata Laluan seperti yang dikehendaki (kata laluan lalai: algo)
   Nota
   Pengesahan standard didayakan secara lalai.

Dayakan Pengesahan Asas (Pilihan)

1. Dalam web antara muka, navigasi ke tab Sistem → Penyelenggaraan dan muat turun konfigurasi file.
2. Buka konfigurasi file dengan mana-mana editor teks dan tambah baris berikut: api.auth.basic = 1
3.  Simpan dan muat naik konfigurasi yang diubah suai file kembali ke peranti menggunakan Konfigurasi Pulihkan File ciri dalam tab Sistem → Penyelenggaraan.

Tiada Kaedah Pengesahan (Pilihan)

Untuk mendayakan kaedah tanpa pengesahan, biarkan medan Kata Laluan API RESTful kosong. Kaedah ini tidak disyorkan dan hanya boleh digunakan untuk tujuan ujian sahaja kerana ia tidak memberikan keselamatan.

Mendayakan Antara Muka Kawalan Mudah (Pilihan)

1. pada web antara muka, navigasi ke tab Sistem → Penyelenggaraan dan muat turun konfigurasi file.
2.  Buka konfigurasi file menggunakan editor teks dan tambah dua baris. Tukar kepada kata laluan keinginan anda. Admin.web.sci = 1
   Sci.admin.pwd =
3.  Simpan dan muat naik konfigurasi yang diubah suai file kembali ke peranti menggunakan Konfigurasi Pulihkan File ciri dalam tab Sistem → Penyelenggaraan.

KEPERLUAN PENGESAHAN

Sila email sokongan@algosolutions.com jika anda mahukan pengesahan standard atau asas sampkod itu.

Permintaan Pengesahan Standard dengan Muatan JSON

Pengepala yang diperlukan dalam permintaan HTTP/HTTPS
> Jenis Kandungan: "aplikasi/json"
> Kandungan-MD5: [content_md5] Cthample
Content-MD5: 74362cc86588b2b3c5a4491baf80375b

Keizinan: hmac admin:[nonce]:[hmac_output]
Tajuk kebenaran terdiri daripada:

1. Rentetan 'hmac admin' diikuti dengan titik bertindih ':'.
2. Nonce – Nilai rawak atau tidak berulang, diikuti dengan titik bertindih ':'.
3. Hmac_output – dijana oleh Kata Laluan API RESTful (kunci rahsia) yang dikonfigurasikan pada peranti anda dan input HMAC, seperti di bawah:
   [kaedah_permintaan]:[request_uri]:[content_md5]:[content_type]:[timestamp]:[tidak pernah]

Input HMAC cthample: (menggunakan 'algo' sebagai kunci rahsia)
POST:/api/controls/tone/start:6e43c05d82f71e77c586e29edb93b129:application/json:1601312252:49936 Jana HMAC dengan kata laluan dan rentetan input HMAC sebagai ringkasan menggunakan SHA-256:
Keluaran HMAC cthample: 2e109d7aeed54a1cb04c6b72b1d854f442cf1ca15eb0af32f2512dd77ab6b330

Tarikh: hari, tarikh bulan, tahun hr:min:sec GMT
Example
Tarikh: Khamis, 22 Sept, 2022 02:33:07 GMT
Pengesahan standard dengan muatan example:

 Permintaan Pengesahan Standard Tanpa Muatan JSON

Sama dengan 3.1 dengan pengepala berkaitan kandungan/input hmac ditinggalkan.
Input HMAC: [request_method]:[request_uri]:[timestamp]:[nonce] Input HMAC cthample: (menggunakan 'algo' sebagai kunci rahsia)
DAPATKAN:/api/settings/audio.page.vol:1601312252:49936
Hasilkan HMAC dengan kata laluan dan rentetan input HMAC menggunakan SHA-256:
Keluaran HMAC cthample: c5b349415bce0b9e1b8122829d32fbe0a078791b311c4cf40369c7ab4eb165a8
Pengesahan standard tanpa muatan cthample:

 Permintaan Pengesahan Asas

Kaedah pengesahan ini harus digunakan dengan berhati-hati kerana ia kurang selamat daripada kaedah standard.

Keizinan: Asas [base64]
Example:
Keizinan: Asas YWRtaW46YWxnbwo=
Pengesahan asas cthample:

PERINTAH

 Perintah API RESTful

Di bawah ialah senarai semua arahan API yang disokong.

Nota
Permintaan PUT menukar atau mencipta sumber kekal yang bertahan daripada but semula, manakala permintaan POST hanya mengawal peranti untuk sesi semasa.

Penerangan	Kaedah	URI	Muatan Parameter	Kembali Example	produk	FW
Dapatkan semula nilai parameter tertentu.	DAPATKAN	/api/settings/[key-name] Cth./api/settings/audio.page.vol	T/A	{“audio.page.vol”: “-18dB”}	Semua	> 3.3
Kembalikan paras hingar ambien yang diukur dalam desibel. Pampasan Bunyi Ambien mesti didayakan dalam Tetapan Asas -> tab Ciri.	DAPATKAN	/api/info/audio.noise.level	T/A	{“audio.noise.level”: 72}	Pembesar Suara Paparkan Pembesar Suara	> 3.3
Ekstrak status terminal input geganti.	DAPATKAN	/api/info/input.relay.status	T/A	{“input.relay.status”: “idle”} atau {“input.relay.status”: “active”}	Semua produk dengan input geganti, kecuali 8063. Lihat di bawah.	> 4.1
Ekstrak status terminal Input 1 atau Input 2.	DAPATKAN	/api/info/input.relay1.status atau /api/info/input.relay2.status	T/A	{“input.relay1.status”: “idle”} atau {“input.relay1.status”: “active”}	8063	> 4.1
Dapatkan semula senarai nada files sedang dipasang.	DAPATKAN	/api/info/tonelist	T/A	{“tonelist”:[“bell-na.wav”,”bell uk.wav”,”buzzer.wav”,…]}	Semua	> 5.0
Dapatkan semula maklumat peranti yang dipaparkan pada halaman Status.	DAPATKAN	/api/info/status	T/A	Senarai penuh maklumat daripada tab Status.	Semua	> 5.4

Dapatkan semula maklumat produk yang dipaparkan pada halaman Perihal.	DAPATKAN	/api/info/about	T/A	Semua maklumat hadir pada tab Perihal.	Semua	> 5.4
Aktifkan strob dengan parameter warna dan corak yang diingini.	POS	/api/controls/strob/start	corak: {0 – 15} warna1: {biru, merah, ambar, hijau} warna2: {biru, merah, ambar, hijau} ledlvl: {1 – 255} penahanan: {benar, palsu}	T/A	8128(G2) 8138 8190S	> 3.3
Hentikan strob.	POS	/api/controls/strob/stop	T/A	T/A	8128(G2) 8138 8190S	> 3.3
Mainkan nada sekali atau gelungkannya.	POS	/api/controls/tone/start	laluan: {tone} ie. loceng.wav gelung: {true, false} atau {0, 1} cth {“path”:”chime.wav”, “loop”:true}	T/A	Pembesar suara 8301 8373 8028(G2) 8201 8039	> 3.3
Hentikan nada.	POS	/api/controls/tone/stop	T/A	T/A	Pembesar suara 8301 8373 8028(G2) 8201 8039	> 3.3
Hubungi sambungan telefon dengan mesej yang telah dirakam.	POS	/api/controls/call/start	{“sambungan”:”2099″, “tone”:”gong.wav”, “interval”:”0″, “maxdur”:”10″}	T/A	Pembesar suara 8301 8410 8420	> 3.3
Tamatkan panggilan.	POS	/api/controls/call/stop	T/A	T/A	Pembesar suara 8301 8410 8420	> 3.3

Mulakan panggilan halaman sehala. Peranti akan menerima strim audio daripada sambungan sasaran.	POS	/api/controls/call/page	{"sambungan":" ”}	T/A	Pembesar suara 8410 8420	> 5.3.4
But semula titik akhir sasaran.	POS	/api/controls/reboot	T/A	T/A	Semua	> 3.3
Buka kunci pintu. “tempatan” mengawal geganti setempat “netdc1” mengawal pengawal pintu rangkaian jauh (8063)	POS	/api/controls/door/unlock	doorid: {local, netdc1} * Pilihan	T/A	8039 8028(G2) 8201 8063	> 3.3
Kunci pintu.	POS	/api/controls/door/lock	doorid: {local, netdc1} * Pilihan	T/A	8039 8028(G2) 8201 8063	> 3.3
Dayakan geganti aux keluar 24v.	POS	api/controls/24v/enable	T/A	T/A	8063	> 5.0
Lumpuhkan geganti aux keluar 24v.	POS	api/controls/24v/disable	T/A	T/A	8063	> 5.0
Dayakan geganti output.	POS	/api/controls/relay/enable	T/A	T/A	8063	> 5.0
Lumpuhkan geganti output.	POS	/api/controls/relay/disable	T/A	T/A	8063	> 5.0
Semak pelayan perisian tegar Algo untuk versi perisian tegar terkini.	POS	/api/controls/upgrade/check	T/A	{“versi”: “dikemas kini”} atau {“versi”: “ ”}	Semua	> 4.1
Semak pelayan perisian tegar Algo untuk versi perisian tegar terkini dan naik taraf kepada versi itu.	POS	/api/controls/upgrade/start	T/A	{“status”: “dikemas kini”} atau {“status”: “menaik taraf ”, “url”: url>} atau {“status”: “ ”}	Semua	> 4.1
Paparkan imej atau corak pada skrin.	POS	/api/controls/screen/start	Lihat di bawah	T/A	8410 8420	> 5.3.4
Hentikan corak skrin dan kembali ke skrin lalai.	POS	/api/controls/screen/stop	T/A	T/A	8410 8420	> 5.3.4

Mulakan semula aplikasi utama.	POS	/api/controls/reload	T/A	T/A	Semua	> 5.3.4
Mula mendengar strim audio langsung. Konfigurasikan nombor port yang strim sedang dihantar.	POS	/api/controls/rx/start	{“port”: }	T/A	Semua	> 5.3.4
Berhenti mendengar strim audio langsung.	POS	/api/controls/rx/stop	T/A	T/A	Semua	> 5.3.4
Tetapkan mod berbilang siaran.	LETAK	/api/state/mcast/update/	{“mod”:”pengirim”, “alamat”: , "port": , “type”:”rtp”} atau {“mode”:”sender”, “address”: , "port": , “type”:”poly”, “group”:1} **Nota**: Jika kawalan/nada/mula digunakan sebelum arahan ini, nada akan dimainkan menggunakan tetapan semasa pada web UI.	T/A	8301	> 5.0
Masukkan nilai pada parameter tertentu daripada muatan JSON.	LETAK	/api/setting	parameter: {value} cth {“audio.page.vol”: “-3dB”}	T/A	8180(G2) 8186 8190 8190S 8301 8373	> 3.3

 Perintah Antara Muka Kawalan Mudah (SCI).

Semua arahan SCI adalah permintaan GET dan mempunyai parameter biasa "usi" dan "admin" untuk pengesahan.
Example:
DAPATKAN http:// /sci/controls/door/unlock?usr=admin&pwd=algo&doorid=local

Penerangan	URI	Tambahan Muatan Parameter	Produk	FW
Buka kunci pintu. “tempatan” mengawal geganti setempat “netdc1” mengawal pengawal pintu rangkaian jauh (8063)	/sci/controls/do or/unlock	doorid: {local, netdc1} * Pilihan	8039 8028(G2) 8201 8063	> 3.3
Kunci pintu.	/sci/controls/do or/lock	doorid: {local, netdc1} * Pilihan	8039 8028(G2) 8201 8063	> 3.3
Mainkan nada sekali atau gelungkannya.	/sci/controls/to ne/start	laluan: {tone} ie. loceng.wav gelung: {true, false} atau {0, 1}	Semua	> 3.3
Hentikan nada.	/sci/controls/to ne/stop	T/A	Semua	> 3.3
Aktifkan strob dengan parameter warna dan corak yang diingini.	/sci/controls/strob/start	corak: {0 – 15} warna1: {biru, merah, ambar, hijau} warna2: {biru, merah, ambar, hijau} ledlvl: {1 – 255} penahanan: {true, false}	8128(G2) 8138 8190S	> 3.3
Hentikan strob.	/sci/controls/strob/stop	T/A	8128(G2) 8138 8190S	> 3.3

Dokumen / Sumber

	API ALGO RESTful [pdf] Panduan Pengguna AL061-GU-GF000API-001-R0, AL061-GU-CP00TEAM-001-R0, RESTful API, RESTful, API
	API ALGO RESTful [pdf] Panduan Pengguna AL061-GU-CP000API-230717, RESTful API, RESTful, API

Rujukan

• Manual Pengguna