Autentifikácia
Rozhranie Connection API používa autentifikáciu pomocou tokenu nosiča. Všetky požiadavky musia v hlavičke autorizácie obsahovať platný prístupový token JWT.
Získajte token
ODOSIEĽAJTE svoje prihlasovacie údaje do autorizačného koncového bodu. Dostanete krátkodobý access_token a dlhodobý refresh_token.
Použite token
Zahrňte token do každej požiadavky:
{
"email": "admin@yourorg.com",
"password": "••••••••"
}{
"access_token": "eyJhbG...",
"refresh_token": "dGhpcw...",
"expires_in": 3600,
"token_type": "Bearer"
}Základná URL adresa a verziovanie
Všetky koncové body API sú verzované pod /api/v1/. Základná URL adresa závisí od vášho nasadenia.
Pre nasadenia hostované v cloude použite regionálny koncový bod priradený k vašej organizácii. Pre lokálne nasadenia servera použite názov hostiteľa vášho servera.
| Životné prostredie | Základná URL adresa |
|---|---|
| Cloud (USA) | https://beta.connection.app/api/v1 |
| Lokálne | https://<your-server>/api/v1 |
Všetky telá požiadaviek a odpovedí používajú application/json. Do požiadaviek s telom zahrňte Content-Type: application/json.
Chyby a stavové kódy
API používa štandardné stavové kódy HTTP. Chybové odpovede zahŕňajú strojovo čitateľný kód a správu čitateľnú človekom.
| Stav | Význam |
|---|---|
| 200 | Úspech |
| 201 | Vytvorené |
| 400 | Neplatná požiadavka – neplatné parametre |
| 401 | Neoprávnené – chýbajúci alebo vypršaný token |
| 403 | Zakázané – nedostatočné oprávnenia |
| 404 | Nenájdené |
| 500 | Interná chyba servera |
{
"error": {
"code": "device_not_found",
"message": "No device with that UUID exists in your organization",
"status": 404
}
}Prehľad REST API
Rozhranie REST API servera Connection Server poskytuje plný programový prístup k vašej flotile zariadení, komunikačnej infraštruktúre a analytickým nástrojom. Dodržiava konvencie RESTful s telami požiadaviek/odpovedí JSON.
Autentifikácia
Autentifikácia založená na tokenoch. Prihlásenie vráti token, ktorý musí byť odoslaný ako Autorizácia: Token<token> pri všetkých nasledujúcich žiadostiach.
Používatelia
Vytváranie a správa používateľských účtov. Koncový bod GET /users/user vráti aktuálne overeného používateľa.
Zariadenia
Zobrazovať a kontrolovať zariadenia, spravovať priradenia používateľov k zariadeniam, čítať a zapisovať nastavenia a stavy jednotlivých zariadení, spravovať obrazy firmvéru a úložiska a prijímať protokoly a správy o zlyhaní.
Proxy CBBP
Odošlite ľubovoľný príkaz CBBP do zariadenia prostredníctvom servera. Server prenesie príkaz cez WiFi pripojenie zariadenia a vráti odpoveď zariadenia. Odchádzajúca odpoveď „make“ tiež obsahuje správu CBBPMessage, ktorú zariadenie okamžite vykoná.
Telo požiadavky je obálka príkazu CBBP. Uložený objekt CBBPCommand sleduje stav doručenia: NENASTAVENÉ → ODOSLANÉ → PRIJATÉ alebo DOBA DORUČENIA UPLYNULA.
{
"outgoingMessage": {
"command": "WiFiScan"
}
}{
"uuid": "a3f2...",
"status": "SENT",
"device": "d7f3a1b2-...",
"dateSent": "2025-09-15T14:22:01Z",
"outgoingMessage": { /* echoed */ },
"incomingMessage": null
}Kanály
Kanály sú základné komunikačné primitívy. Medzi typy patria ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService a ChannelRecorder.
Komunikácia
Iniciovať a spravovať aktívne komunikačné relácie – odchádzajúce hovory, VCP, nahrávanie a streamovanie obsahu. Odpoveď typu „outgoing-make“ obsahuje správu CBBPMessage, na ktorú zariadenie okamžite reaguje.
Zvukový most
Získajte prístup k nahraným premosťovacím konverzáciám vrátane úplných prepisov, zoznamov účastníkov a súhrnov generovaných umelou inteligenciou. Podporuje viacero šablón súhrnov (poznámky zo stretnutí, poznámky z hodín, zdravotná starostlivosť atď.) a generovanie zvuku TTS pre súhrny.
Konverzácie
Konverzačné relácie s umelou inteligenciou pomocou ChatGPT, Gemini alebo natívneho enginu. Podporuje viacero person (lekár, tútor, mechanik atď.) a stránkovanú históriu správ.
Obsah
Prehliadajte a prehrávajte streamovaný audio obsah na zariadeniach. Obsah je usporiadaný do stromu kategórií; populárny obsah je možné filtrovať podľa mesta, regiónu alebo krajiny.
Lokality
Previesť geografické súradnice na štruktúrovaný objekt mesta, regiónu a krajiny. Používa sa zariadeniami pri prijímaní kontextu.
Push notifikácie
Zaregistrujte si mobilnú aplikáciu a dostávajte push notifikácie FCM. Podporuje iOS, Android a webové ciele.
Skladovanie
Stiahnite súbory uložené na objektoch modelu a spustite odstránenie pozadia obrázka (vracia výsledok kódovaný v base64).
Hromadné operácie
Vykonajte viacero operácií API v jednej HTTP požiadavke. Zadajte single_transaction=true, aby sa všetky operácie zabalili do jednej atomickej transakcie – zlyhanie ľubovoľnej položky vráti späť celú dávku.
Dátum a čas
Vráti aktuálny dátum a čas servera v GMT+0. Nevyžaduje overenie. Používa sa zariadeniami na synchronizáciu ich interných hodín.
Základný protokol Com Badge
CBBP je odľahčený protokol JSON pre priamu interakciu s odznakmi pripojenia. Poskytuje vám plnú kontrolu nad každou hardvérovou a softvérovou funkciou na zariadení.
Formát správy
Každá interakcia CBBP pozostáva z príkazovej správy odoslanej do zariadenia a výslednej správy vrátenej zariadením.
Pole objektu v požiadavke aj odpovedi obsahuje údaje špecifické pre príkaz a môže sa vynechať, ak nie je potrebné.
{
"command": "command_name",
"object": {
// optional command parameters
}
}{
"result": 0, // 0 = success, -1 = error
"detail": "ok", // human-readable status
"object": { // optional response data
// command-specific fields
}
}Doprava
Správy CBBP je možné doručiť na odznak prostredníctvom troch rôznych transportov v závislosti od vašej integračnej architektúry.
Bluetooth (aplikácia)
Posielajte príkazy CBBP priamo z mobilnej aplikácie cez BLE. Vyžaduje sa, aby bolo zariadenie spárované a v dosahu.
Mobilná SDKWiFi alebo Bluetooth cez server
Proxy CBBP cez REST API — POST /devices//cbbp. Server automaticky smeruje k zariadeniu cez WiFi alebo Bluetooth v závislosti od toho, ako je odznak pripojený. Najbežnejšie pre backendové integrácie.
REST APIInterná expedícia
Odosielanie CBBP na zariadení alebo medzi procesmi. Používa ho firmvér odznaku na smerovanie príkazov medzi internými subsystémami.
Iba firmvérPríkazy napájania
Ovládanie stavu napájania zariadenia – režim spánku, prebudenie, reštart a obnovenie do továrenských nastavení.
Príkazy WiFi
Konfigurujte bezdrôtové siete, vyhľadávajte prístupové body, kontrolujte stav pripojenia a spravujte uložené prihlasovacie údaje.
Príkazy Bluetooth
Ovládajte reklamu BLE, párovanie a komunikáciu medzi odznakmi.
Príkazy nastavení
Čítanie a zapisovanie konfigurácie zariadenia – zobrazovaný názov, časové pásmo, jazyk a príznaky funkcií.
Príkazy firmvéru
Spúšťajte aktualizácie firmvéru OTA, kontrolujte stav aktualizácií a zistite aktuálnu verziu firmvéru v zariadení.
Príkazy zariadenia
Životný cyklus zariadenia, autentifikácia, konfigurácia, protokolovanie, stav a riadenie hardvéru.
Komunikačné príkazy
Iniciujte hovory, odosielajte správy, spravujte aktívne komunikačné relácie a ovládajte nahrávanie.
Zvukové príkazy
Ovládajte hlasitosť reproduktora, zosilnenie mikrofónu, zvukové profily a prehrávanie textu na reč.
Príkazy LED diód
Nastavte farbu, jas a animačné vzory LED diódy na kontrolke odznaku.
Interné príkazy
Interné príkazy na odoslanie používané na doručovanie kontextu, históriu kanálov, vokalizáciu a dekódovanie zvuku.
Mobilné príkazy
Príkazy na koordináciu odznaku so spárovanou mobilnou aplikáciou – push notifikácie, synchronizácia stavu aplikácie a deep linking.