Autentifikācija
Savienojuma API izmanto nesēja marķiera autentifikāciju. Visiem pieprasījumiem autorizācijas galvenē ir jāiekļauj derīgs JWT piekļuves marķieris.
Iegūt žetonu
NOSŪTIET savus akreditācijas datus uz autentifikācijas galapunktu. Jūs saņemsiet īslaicīgu access_token un ilgāku refresh_token.
Izmantojiet žetonu
Iekļaujiet žetonu katrā pieprasījumā:
{
"email": "admin@yourorg.com",
"password": "••••••••"
}{
"access_token": "eyJhbG...",
"refresh_token": "dGhpcw...",
"expires_in": 3600,
"token_type": "Bearer"
}Bāzes URL un versiju pārvaldība
Visi API galapunkti ir versiju failā /api/v1/. Pamata URL ir atkarīgs no jūsu izvietojuma.
Mākonī izvietotām izvietošanām izmantojiet jūsu organizācijai piešķirto reģionālo galapunktu. Lokālā servera izvietošanai izmantojiet sava servera resursdatora nosaukumu.
| Vide | Bāzes URL |
|---|---|
| Mākonis (ASV) | https://beta.connection.app/api/v1 |
| Lokāli | https://<your-server>/api/v1 |
Visos pieprasījumu un atbilžu pamattekstos tiek izmantots application/json. Pieprasījumos ar pamattekstu iekļaujiet Content-Type: application/json.
Kļūdas un statusa kodi
API izmanto standarta HTTP statusa kodus. Kļūdu atbildes ietver mašīnlasāmu kodu un cilvēkam lasāmu ziņojumu.
| Statuss | Nozīme |
|---|---|
| 200 | Panākumi |
| 201 | Izveidots |
| 400 | Nederīgs pieprasījums — nederīgi parametri |
| 401 | Neautorizēts — trūkstošs vai beidzies pilnvara |
| 403 | Aizliegts — nepietiekamas atļaujas |
| 404 | Nav atrasts |
| 500 | Iekšēja servera kļūda |
{
"error": {
"code": "device_not_found",
"message": "No device with that UUID exists in your organization",
"status": 404
}
}REST API pārskats
Savienojuma servera REST API nodrošina pilnīgu programmatisku piekļuvi jūsu ierīču parkam, sakaru infrastruktūrai un analītikai. Tas ievēro RESTful konvencijas ar JSON pieprasījumu/atbildes pamattekstiem.
Autentifikācija
Uz žetoniem balstīta autentifikācija. Pieteikšanās atgriež žetonu, kas jānosūta kā Autorizācija: Žetons<token> par visiem turpmākajiem pieprasījumiem.
Lietotāji
Izveidojiet un pārvaldiet lietotāju kontus. GET /users/user galapunkts atgriež pašlaik autentificēto lietotāju.
Ierīces
Uzskaitīt un pārbaudīt ierīces, pārvaldīt lietotāju un ierīču asociācijas, lasīt un rakstīt katras ierīces iestatījumus un statusu, apstrādāt programmaparatūras un krātuves attēlus, kā arī saņemt žurnālus un avāriju pārskatus.
CBBP starpniekserveris
Nosūtiet jebkuru CBBP komandu uz ierīci, izmantojot serveri. Serveris pārraida komandu, izmantojot ierīces Wi-Fi savienojumu, un atgriež ierīces atbildi. Izejošā make atbilde ietver arī CBBPMessage, ko ierīce nekavējoties izpilda.
Pieprasījuma pamatteksts ir CBBP komandas aploksne. Saglabātais CBBPCommand objekts izseko piegādes statusu: UNSET → SENT → RECEIVED vai TIMED_OUT.
{
"outgoingMessage": {
"command": "WiFiScan"
}
}{
"uuid": "a3f2...",
"status": "SENT",
"device": "d7f3a1b2-...",
"dateSent": "2025-09-15T14:22:01Z",
"outgoingMessage": { /* echoed */ },
"incomingMessage": null
}Kanāli
Kanāli ir galvenie saziņas primitīvi. To veidi ir ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService un ChannelRecorder.
Komunikācija
Uzsākt un pārvaldīt aktīvas saziņas sesijas — izejošos zvanus, VCP, ierakstīšanu un satura straumēšanu. Izejošā atbilde ietver CBBPMessage, uz kuru ierīce nekavējoties reaģē.
Audio tilts
Piekļūstiet ierakstītām tilta sarunām, tostarp pilniem transkriptiem, dalībnieku sarakstiem un mākslīgā intelekta ģenerētiem kopsavilkumiem. Atbalsta vairākas kopsavilkumu veidnes (sanāksmju piezīmes, nodarbību piezīmes, veselības aprūpe utt.) un TTS audio ģenerēšanu kopsavilkumiem.
Sarunas
Ar mākslīgo intelektu darbinātas sarunu sesijas, izmantojot ChatGPT, Gemini vai iebūvēto dzinēju. Atbalsta vairākas personas (ārsts, pasniedzējs, mehāniķis utt.) un lappušu ziņojumu vēsturi.
Saturs
Pārlūkojiet un atskaņojiet straumējamu audio saturu ierīcēs. Saturs ir sakārtots kategoriju kokā; populāro saturu var filtrēt pēc pilsētas, reģiona vai valsts.
Atrašanās vietas
Atrisināt ģeogrāfiskās koordinātas strukturētā pilsētas, reģiona un valsts objektā. Ierīces to izmanto, uzņemot kontekstu.
Push paziņojumi
Reģistrējiet mobilo lietotni, lai saņemtu FCM push paziņojumus. Atbalsta iOS, Android un tīmekļa mērķus.
Uzglabāšana
Lejupielādējiet modeļa objektos saglabātos failus un palaidiet attēla fona noņemšanu (atgriež base64 kodētu rezultātu).
Lielapjoma operācijas
Izpildiet vairākas API darbības vienā HTTP pieprasījumā. Nododiet single_transaction=true, lai visas darbības ietvertu vienā atomārā transakcijā — jebkura vienuma kļūme atceļ visu paketi.
Datums un laiks
Atgriež pašreizējo servera datumu un laiku GMT+0 formātā. Nav nepieciešama autentifikācija. Ierīces izmanto, lai sinhronizētu savu iekšējo pulksteni.
Com Badge pamata protokols
CBBP ir viegls JSON komandu protokols tiešai mijiedarbībai ar savienojuma žetoniem. Tas sniedz jums pilnīgu kontroli pār visām ierīces aparatūras un programmatūras funkcijām.
Ziņojuma formāts
Katra CBBP mijiedarbība sastāv no ierīcei nosūtīta komandas ziņojuma un ierīces atgriezta rezultāta ziņojuma.
Gan pieprasījumā, gan atbildē objekta lauks satur komandai specifiskus datus, un to var izlaist, ja tas nav nepieciešams.
{
"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
}
}Transports
CBBP ziņojumus var piegādāt uz žetonu, izmantojot trīs dažādus transporta veidus atkarībā no jūsu integrācijas arhitektūras.
Bluetooth (lietotne)
Sūtiet CBBP komandas tieši no mobilās lietotnes, izmantojot BLE. Ierīcei jābūt savienotai pārī un jāatrodas diapazonā.
Mobilo ierīču SDKWi-Fi vai Bluetooth caur serveri
CBBP starpniekserveris, izmantojot REST API — POST /devices//cbbp. Serveris automātiski novirza datus uz ierīci, izmantojot Wi-Fi vai Bluetooth atkarībā no tā, kā ir pievienota ierīce. Visizplatītākais risinājums aizmugursistēmas integrācijām.
REST APIIekšējā dispečera
CBBP nosūtīšana ierīcē vai starpprocesu režīmā. Izmanto žetonu programmaparatūra, lai maršrutētu komandas starp iekšējām apakšsistēmām.
Tikai programmaparatūraJaudas komandas
Ierīces barošanas stāvokļa kontrole — miega režīms, aktivizēšana, atkārtota palaišana un rūpnīcas datu atiestatīšana.
WiFi komandas
Konfigurējiet bezvadu tīklus, skenējiet piekļuves punktus (AP), pārbaudiet savienojuma statusu un pārvaldiet saglabātos akreditācijas datus.
Bluetooth komandas
Kontrolējiet BLE reklāmas, savienošanu pārī un saziņu starp ierīcēm.
Iestatījumu komandas
Lasīt un rakstīt ierīces konfigurāciju — parādāmo nosaukumu, laika joslu, valodu un funkciju karodziņus.
Programmatūras komandas
Aktivizējiet OTA programmaparatūras atjauninājumus, pārbaudiet atjaunināšanas statusu un vaicājiet ierīces pašreizējo programmaparatūras versiju.
Ierīces komandas
Ierīces dzīves cikls, autentifikācija, konfigurācija, reģistrēšana, statuss un aparatūras kontrole.
Komunikācijas komandas
Veiciet zvanus, sūtiet ziņojumus, pārvaldiet aktīvās saziņas sesijas un kontrolējiet ierakstīšanu.
Audio komandas
Kontrolējiet skaļruņa skaļumu, mikrofona pastiprinājumu, audio profilus un teksta pārveidošanas runā atskaņošanu.
LED komandas
Iestatiet LED krāsu, spilgtumu un animācijas modeļus uz žetonu indikatora gaismas.
Iekšējās komandas
Iekšējās nosūtīšanas komandas, ko izmanto konteksta piegādei, kanāla vēsturei, vokalizācijai un audio dekodēšanai.
Mobilās komandas
Komandas žetonam piesaistītas mobilās lietotnes koordinēšanai — push paziņojumi, lietotnes stāvokļa sinhronizācija un dziļās saites.