API Awam Platform Awan avi-on
Maklumat
- Maklumat produk tertakluk kepada perubahan tanpa notis. Semak sokongan Avi-on weblaman web untuk maklumat terkini.
- Tanda perkataan dan logo Bluetooth® ialah tanda dagangan berdaftar yang dimiliki oleh Bluetooth SIG, Inc. dan sebarang penggunaan tanda sedemikian oleh Avi-on Labs, Inc. adalah di bawah lesen.
- Semua tanda dagangan diiktiraf sebagai hak milik pemilik masing-masing.
- Untuk memastikan kebolehpercayaan yang optimum dan untuk memenuhi keperluan waranti, produk Avi-on mesti dipasang mengikut arahan dalam manual ini.
Penonton
Manual ini bertujuan untuk digunakan oleh kakitangan pemasangan dan penyelenggaraan profesional yang mahir. Bahaya keselamatan dan kejutan mungkin ada semasa pemasangan.
Berakhirview
- API ini direka bentuk untuk pembangun aplikasi mengakses platform melalui API awan kami untuk mencipta mudah alih atau web aplikasi yang menyambung melalui perkhidmatan awan Avi-on untuk mengendalikan peranti dalam Rangkaian Avi-on. API juga membenarkan penemuan peranti, kumpulan dan adegan untuk dikawal, serta status semasa peranti.
- Untuk API berfungsi, pengguna mesti mempunyai Jambatan Akses Jauh yang dikonfigurasikan dan dalam talian untuk menyambungkan rangkaian Mesh setempat mereka kepada perkhidmatan awan Avi-on.
- Elemen utama API termasuk pengesahan dan pengurusan token sesi, dapatkan maklumat status akaun, dapatkan konfigurasi peranti dan ciri yang tersedia, dan siarkan keadaan baharu pada peranti, kumpulan atau adegan untuk pemalapan dan penukaran warna.
- Keluaran sekarang tidak menyokong penciptaan atau pengubahsuaian kumpulan, jadual atau adegan melalui API. Dalam kebanyakan kes, logik yang kompleks diperlukan untuk memastikan perubahan disegerakkan dengan betul merentas semua peranti yang terjejas. Ini harus disediakan menggunakan aplikasi Avi-on, dan kemudian ia boleh dikendalikan melalui API.
- Untuk mengakses API, sistem jauh mesti mempunyai e-mel dan kata laluan pengguna avi-on semasa secara bebas untuk setiap akaun pengguna untuk diakses. Penyepaduan lain, seperti OATH2 boleh dilakukan sebagai penglibatan perkhidmatan dengan Avi-on.
- Sila hubungi Avi-on untuk terma pelesenan dan kos sokongan perkhidmatan dan skop untuk penyepaduan pengeluaran.
- API Awam merangkumi setiap titik akhir yang boleh diakses oleh Pengguna dengan peranan Pengguna Akhir. Arahan berikut menerangkan cara untuk mengesahkan pengguna yang dibuat melalui apl Avi-on (atau apl pihak ketiga menggunakan API kami) dan menggunakan set API yang ditakrifkan sebagai Awam untuk pembangun pihak ketiga.
Sokongan
Sokongan tersedia kepada pemegang lesen peranti Avi-on berdasarkan perkhidmatan profesional. Hubungi support@avi-on.com untuk mendapatkan petikan sokongan tersuai berdasarkan keperluan anda.
Pengesahan
- Penggunaan Avi-on berdasarkan strategi Pengesahan Asas HTTP untuk menguatkuasakan kawalan akses kepada API kami. Penciptaan Token Sesi dilakukan dengan POST (hanya disokong oleh HTTPS) dengan 0e-mel dan kata laluan dalam badan sebagai JSON. Kami tidak menyokong penghantaran maklumat ini dalam format lain.
- Jika maklumat yang diberikan (e-mel dan kata laluan) adalah betul, API bertindak balas dengan Token dan Token Segar Semula untuk digunakan dalam permintaan berikut dalam pengepala: Keizinan: Token . Masa tamat tempoh token untuk API ialah seminggu dan token muat semula sebulan.
Cipta Token Sesi
- Jika maklumat yang diberikan (e-mel dan kata laluan) adalah betul, API bertindak balas dengan Token dan Token Segar Semula untuk digunakan dalam permintaan berikut dalam pengepala: Keizinan: Token . Masa tamat tempoh token untuk API ialah seminggu dan token muat semula sebulan.
- Langkah pertama untuk menggunakan API Awam ialah membuat token kebenaran dengan nama pengguna dan kata laluan.
- POS http://api.avi-on.com/sessions
Muatan (JSON
| Nama | taip | Penerangan |
| emel | e-mel pengguna | rentetan |
| rentetan | kata laluan | Kata laluan pengguna |
Tajuk:
| Nama | Nilai |
| Jenis Kandungan | aplikasi / json |
jawapan:
| Nama | taip | Penerangan |
| auth_token | rentetan | Token untuk pengesahan |
| kemampuan* | Susunan | Senarai keupayaan |
| email_verified | Boolean | Pengesahan e-mel |
| telefon_disahkan | Boolean | Pengesahan telefon |
| refresh_token** | rentetan | Token untuk mendapatkan token baharu apabila auth_token tamat tempoh |
| tarikh luput | Tarikh/Masa | Masa selepas auth_token memerlukan muat semula |
Respons (Kod 201):
Atribut kelayakan dalam. Abaikan selebihnya respons. Ia untuk kegunaan dalaman.
| Nama | taip | Penerangan |
| auth_token | rentetan | Token untuk pengesahan |
| kemampuan* | Susunan | Senarai keupayaan |
| email_verified | Boolean | Pengesahan e-mel |
| telefon_disahkan | Boolean | Pengesahan telefon |
| refresh_token** | rentetan | Token untuk mendapatkan token baharu apabila auth_token tamat tempoh |
| tarikh luput | tarikh | Tarikh/Masa apabila Token memerlukan muat semula |
Ralat:
| Kod | Respon | Sebab |
| 401 | {“error”:{“auth”:[“E-mel atau Kata Laluan Salah.”]}} | Deskriptif diri. Bukti kelayakan adalah salah. |
| 401 | {“error”:{“credentials”:[“missing credentials”]}} | Data telah dihantar (semak Jenis Kandungan). |
Example:
curl -X POST http://api.avi-on.com/user/devices -H “Content-Type: application/json” -d “{\”email\”:\”user@domain.com\”,\ ”kata laluan\”:\”kata laluan\”}”
Kod 201
Token Sesi Segar semula
Untuk memuat semula token setelah tamat tempoh. Ia adalah titik akhir yang sama tetapi mesti menyertakan pengepala Kebenaran dengan token muat semula sebagai nilai. Lihat Tajuk di bawah: PUT http://api.avi-on.com/sessions
Tajuk:
| Nama | Nilai |
| Jenis Kandungan | aplikasi / json |
| Keizinan | RefreshToken |
jawapan:
Sama seperti Buat Token Sesi.
Ralat:
| Kod | Respon | Sebab |
| 401 | {“error”:{“auth”:[“Inco{“error”:{“refresh_token”:[“Invalid Refresh Token”]}} betulkan E-mel atau Kata Laluan.”]}} | Token muat semula adalah salah |
| 401 | {“error”:{“credentials”:[“Missing credentials”]}}{“error”:{“credentials”:[“Missing credentials”]}} | Token Segar Semula tiada |
API Peranti Pengguna
Tujuannya adalah untuk mengenal pasti keadaan semasa peranti (bukan kumpulan atau adegan pada masa ini). Ini termasuk:
- Tahap Malap semasa
- Suhu Warna Semasa (Kelvin)
- Adegan aktif
- Nama Peranti dan keupayaan
Dapatkan Keadaan Peranti
DAPATKAN http://api.avi-on.com/user/devices
Tajuk:
| Nama | Nilai |
| Jenis Kandungan | aplikasi / json |
| Keizinan | Token |
Ralat:
| Kod | Respon | Sebab |
| 401 | {“error”:{“auth_token”:[“Token Tidak Sah”]}} | Token tidak lagi sah |
| 401 | {“error”:{“credentials”:[“missing credentials”]}} | Token Segar Semula tiada |
Respons (Kod 200):
API negeri
Dapatkan Negeri
DAPATKAN http://api.avi-on.com/<operable>/<pid>/state
Parameter:
| Nama | Nilai |
| boleh dikendalikan | Oneoperablefrom:peranti, grouporscene |
| pid | ID Awam |
Tajuk:
| Nama | Nilai |
| Jenis Kandungan | aplikasi / json |
| Keizinan | Token |
Respons (Kod 200):
| Padang | Penerangan |
| nama | Nama standard ciri stateful |
| nilai | Nilai semasa dalam format protokol dalaman |
| berperikemanusiaan | Nilai dalam format yang boleh dibaca manusia |
Ralat:
| Kod | Respon | Sebab |
| 401 | {“error”:{“auth_token”:[“Token Tidak Sah”]}} | Token tidak lagi sah |
| 401 | {“error”:{“credentials”:[“missing credentials”]}} | RefreshToken tiada |
| 403 | {“ralat”:{“keizinan”:[“Akses dilarang”]}} | Akses tanpa kebenaran kepada yang boleh dikendalikan |
| 404 | {“ralat”:” tidak ditemui"}% | PID yang disediakan tidak terdapat dalam pangkalan data |
Kemas kini Negeri
POS http://api.avi-on.com/<operable>/<pid>/state
Perameter:
| Nama | Nilai |
| boleh dikendalikan | Oneoperablefrom:peranti, grouporscene |
| pid | ID Awam |
Muatan (JSON): Negeri
| Nama | taip | Penerangan |
| emel | rentetan | Nama standard ciri stateful |
| nilai* | rentetan | Nilai Baharu dalam JSON |
* Lihat maklumat lanjut tentang nilai yang sah untuk hartanah di bawah.
Tajuk:
| Nama | Nilai |
| Jenis Kandungan | aplikasi / json |
| Keizinan | Token |
Respons (Kod 200):
Ralat:
Respons (Kod 200):
| Padang | Penerangan |
| nama | Nama standard ciri stateful |
| nilai | Nilai semasa dalam format protokol dalaman |
| berperikemanusiaan | Nilai dalam format yang boleh dibaca manusia |
Format Nilai Pilihan:
| Kod | Respon | Sebab |
| on_off | Rentetan dalam huruf kecil (hidup, mati) atau dalam integer (1,0) | “hidup”, “mati”, “1”, “0” |
| malap | Peratustage antara 0-100% atau antara 0-255. Juga menyokong penambahan delta. | “100%” (peredupan penuh) atau “0” (mati). “+10%”, “-25%” |
| putih | Kelvin antara 1500-7000. Juga menyokong penambahan delta. | “2200” (panas), “5500” (siang hari). “-25%” (lebih panas), “+25%” (lebih sejuk) |
| rgb | [Merah, Hijau, Biru] | “[255,0,0]” (untuk Merah) |
| tindakan | Hanya ciri untuk adegan. Idem sebagai on_off. | “hidup”, “mati”, “1”, “0” |
Analitis
Set titik akhir ini tersedia untuk menyediakan maklumat sejarah bagi peranti di bawah setiap lokasi. Kami mengumpulkan penggunaan tenaga dan peristiwa peredupan yang kemudiannya boleh dilaporkan melalui perkara berikut.
Dapatkan Penggunaan Tenaga
DAPATKAN http://api.avi-on.com/locations/{{location_pid}}/energy?
pids=60d4d8a06472,27460a8d4d06&type=device&from=2019-04-01&to=2019-04-07
Boleh ditanya untuk kedua-dua kumpulan atau set peranti. Pertanyaan kumpulan menyokong satu kumpulan pada setiap permintaan, manakala pertanyaan untuk peranti menyokong satu set peranti. Anda perlu menentukan jenis permintaan (peranti atau kumpulan), tarikh mula dan tamat untuk laporan (termasuk) dan set pid untuk entiti yang diperlukan.
Akan mengembalikan senarai peranti atau kumpulan dengan set masa berpasanganamp
Tajuk:
| Nama | Nilai |
| Jenis Kandungan | aplikasi / json |
| Keizinan | Token |
Parameter:
| Nama | Nilai | Penerangan |
| pid | 60d4d8a06472,27460a8d4d06 | Diperlukan – senarai pid peranti yang dipisahkan koma, atau satu pid kumpulan. |
| taip | peranti | Diperlukan – salah satu daripada, "peranti" atau "kumpulan" untuk mengumpul data bagi set peranti atau kumpulan. |
| daripada | 2019-04-01 | Diperlukan – Tarikh mula TTTT-MM-DD untuk laporan. |
| kepada | 2019-04-07 | Diperlukan – Tarikh tamat YYYY-MM-DD untuk laporan. |
Dapatkan Acara untuk peranti di lokasi
DAPATKAN http://api.avi-on.com/locations/{{location_pid}}/events?
pids=60d4d8a06472,27460a8d4d06&type=device&from=2019-04-01&to=2019-04-07&feature=dim
Boleh ditanya untuk kedua-dua kumpulan atau set peranti. Pertanyaan kumpulan menyokong satu kumpulan pada setiap permintaan, manakala pertanyaan untuk peranti menyokong satu set peranti. Anda perlu menentukan jenis permintaan (peranti atau kumpulan), tarikh mula dan tamat untuk laporan (termasuk) dan set pid untuk entiti yang diperlukan.
Akan mengembalikan senarai peranti atau kumpulan dengan set masa berpasanganamp
Tajuk:
| Nama | Nilai |
| Jenis Kandungan | aplikasi / json |
| Keizinan | Token |
Parameter:
| Nama | Nilai | Penerangan |
| pid | 60d4d8a06472,27460a8d4d06 | Diperlukan – senarai pid peranti yang dipisahkan koma, atau satu pid kumpulan. |
| taip | peranti | Diperlukan – salah satu daripada, "peranti" atau "kumpulan" untuk mengumpul data bagi set peranti atau kumpulan. |
| daripada | 2019-04-01 | Diperlukan – Tarikh mula TTTT-MM-DD untuk laporan. |
| kepada | 2019-04-07 | Diperlukan – Tarikh tamat YYYY-MM-DD untuk laporan. |
| ciri | malap |
SEMUA PRODUK, SPESIFIKASI PRODUK DAN DATA TERTAKLUK PADA PERUBAHAN TANPA NOTIS UNTUK MENINGKATKAN KEBOLEHPERCAYAAN, FUNGSI ATAU REKA BENTUK ATAU SEBALIKNYA.
Maklumat yang terkandung di sini dipercayai boleh dipercayai. Avi-on tidak membuat waranti, perwakilan atau jaminan mengenai maklumat yang terkandung di sini, kesesuaian produk untuk sebarang tujuan tertentu, atau pengeluaran berterusan mana-mana produk. Avi-on tidak bertanggungjawab atau liabiliti apa pun untuk penggunaan maklumat yang terkandung di sini. Maklumat yang terkandung di sini, atau sebarang penggunaan maklumat tersebut tidak memberikan, secara jelas atau tersirat, kepada mana-mana pihak apa-apa hak paten, lesen, atau mana-mana hak harta intelek lain, sama ada berkenaan dengan maklumat tersebut sendiri atau apa-apa yang diterangkan oleh maklumat tersebut.
Dokumen / Sumber
 |
API Awam Platform Awan avi-on [pdf] Panduan Pengguna API Awam Platform Awan, API Awam Platform, API Awam |
