WebSocket je protokol, který poskytuje plně duplexní komunikační kanál mezi klientem a API desky, místnosti nebo stolního zařízení. Objekty JSON-RPC slouží k přenosu příkazů rozhraní API přes WebSocket.
Chcete-li povolit použití WebSocket, je nutné nastavit na FollowHTTPService. Vzhledem k tomu, že WebSocket staví na protokolu HTTP, je nutné nastavit na HTTP + HTTPS nebo HTTPS.
Tyto konfigurace jsou k dispozici jak z webového rozhraní zařízení, tak v rozhraní API. Přečtěte si článek Upřesnit nastavení , kde najdete informace o tom, jak získat přístup k webovému rozhraní a jak používat rozhraní API.
Nativní rozhraní API místnosti nebo stolního zařízení se často označuje jako xAPI.
Přečtěte si příručku xAPI over WebSocket, kde najdete podrobnosti o tom, jak nastavit WebSocket a jak používat objekty JSON-RPC k přenosu příkazů rozhraní API.
Úplný popis samotného rozhraní xAPI najdete v referenční příručce rozhraní API.