Elgato Key Light dan Key Light Air adalah lampu video LED dengan pencahayaan tepi yang populer di kalangan live streamer di platform seperti Twitch. Lampu ini adalah perangkat IoT dan biasanya dikontrol dengan aplikasi 'Pusat Kontrol' Elgato atau melalui salah satu perangkat Stream Deck (juga diproduksi oleh Elgato). Perangkat Key Light tidak secara asli mendukung integrasi pihak ketiga, namun dapat dikontrol dengan berinteraksi langsung dengan API bawaan lampu.
Aplikasi 'Pusat Kontrol' mengirimkan perintah ke perangkat Key Light yang telah dikaitkan melalui HTTP. Permintaan API yang ditentukan dalam dokumen ini ditemukan menggunakan Wireshark dan referensi versi 1.1.2 dari aplikasi Elgato 'Control Center' (Windows 10).
Setelah ditambahkan ke jaringan, perangkat Key Light kemungkinan menerima alamat IP dari router melalui DHCP. Alamat IP tertentu dapat diambil dari server DHCP/router jaringan, tetapi alamat tersebut juga mudah diakses di aplikasi 'Pusat Kontrol'. Untuk melakukan ini:
Accessory settings
(berbentuk seperti penggeser) di samping nama perangkatAdvanced
. Alamat IP akan disajikan di bawah Perilaku Penyalaan dan Versi FirmwarePerangkat Key Light mendengarkan perintah pada port 9123 .
Semua permintaan harus dikirim ke /elgato
.
Dapatkan pengaturan perangkat saat ini:
curl --location --request GET 'http://192.168.1.61:9123/elgato/lights' --header 'Accept: application/json'
Perangkat Key Light tidak memerlukan otentikasi.
Perangkat Key Light hanya mengembalikan dua kode status HTTP:
200 OK
Permintaan berhasil.400 Bad Request
Permintaan tidak dipahami oleh perangkat (kemungkinan karena format sintaksis salah)Selain itu, data apa pun yang dikembalikan oleh perangkat akan berformat JSON.
Hanya ada tiga sumber daya yang diterapkan oleh Key Light API
lights
berisi informasi terkait status, kecerahan, dan suhu warna perangkat Key Light saat iniaccessory-info
info aksesori berisi informasi terkait spesifikasi perangkat keras fisik perangkat Key Lightsettings
berisi informasi yang berkaitan dengan perilaku perangkat Key Light Ada satu 'tindakan' yang diterapkan oleh Key Light API:
identify
pengiriman permintaan HTTP POST ke titik akhir ini akan menyebabkan lampu yang diberikan berkedip beberapa kali