Verifikasie
Die Verbindings-API gebruik Draer-token-verifikasie. Alle versoeke moet 'n geldige JWT-toegangstoken in die Magtiging-koptekst insluit.
Kry 'n teken
POS jou geloofsbriewe na die outoriseringseindpunt. Jy sal 'n kortstondige toegangstoken en 'n langerstondige refresh_token ontvang.
Gebruik die teken
Sluit die teken in elke versoek in:
{
"email": "admin@yourorg.com",
"password": "••••••••"
}{
"access_token": "eyJhbG...",
"refresh_token": "dGhpcw...",
"expires_in": 3600,
"token_type": "Bearer"
}Basis-URL en weergawebeheer
Alle API-eindpunte word onder /api/v1/ weergawes gebruik. Die basis-URL hang af van jou implementering.
Vir wolk-gehosteerde implementerings, gebruik die streekseindpunt wat aan jou organisasie toegeken is. Vir plaaslike bediener-implementerings, gebruik jou bediener se gasheernaam.
| Omgewing | Basis-URL |
|---|---|
| Wolk (VSA) | https://beta.connection.app/api/v1 |
| Op die perseel | https://<your-server>/api/v1 |
Alle versoek- en antwoordliggame gebruik application/json. Sluit Content-Type: application/json in op versoeke met 'n liggaam.
Foute en statuskodes
Die API gebruik standaard HTTP-statuskodes. Foutresponse sluit 'n masjienleesbare kode en 'n mensleesbare boodskap in.
| Status | Betekenis |
|---|---|
| 200 | Sukses |
| 201 | Geskep |
| 400 | Slegte versoek — ongeldige parameters |
| 401 | Ongemagtig — ontbrekende of vervalde teken |
| 403 | Verbode — onvoldoende toestemmings |
| 404 | Nie gevind nie |
| 500 | Interne bedienerfout |
{
"error": {
"code": "device_not_found",
"message": "No device with that UUID exists in your organization",
"status": 404
}
}REST API-oorsig
Die Connection Server REST API bied volle programmatiese toegang tot jou toestelvloot, kommunikasie-infrastruktuur en analise. Dit volg RESTful-konvensies met JSON-versoek-/reaksie-liggame.
Verifikasie
Teken-gebaseerde verifikasie. Aanmelding stuur 'n teken terug wat gestuur moet word as Magtiging: Teken<token> op alle daaropvolgende versoeke.
Gebruikers
Skep en bestuur gebruikersrekeninge. Die GET /users/user-eindpunt gee die tans geverifieerde gebruiker terug.
Toestelle
Lys en inspekteer toestelle, bestuur gebruiker-toestel-assosiasies, lees en skryf per-toestel instellings en status, hanteer firmware en stoorbeelde, en ontvang logboeke en ongeluksverslae.
CBBP-instaanbediener
Stuur enige CBBP-opdrag na 'n toestel deur die bediener. Die bediener stuur die opdrag oor die toestel se WiFi-verbinding en stuur die toestel se reaksie terug. Die uitgaande-maak-reaksie bevat ook 'n CBBPMessage wat die toestel onmiddellik uitvoer.
Die versoekliggaam is 'n CBBP-opdragkoevert. Die gestoorde CBBPCommand-objek spoor afleweringsstatus na: ONGESTELD → GESTUUR → ONTVANG of TIMED_OUT.
{
"outgoingMessage": {
"command": "WiFiScan"
}
}{
"uuid": "a3f2...",
"status": "SENT",
"device": "d7f3a1b2-...",
"dateSent": "2025-09-15T14:22:01Z",
"outgoingMessage": { /* echoed */ },
"incomingMessage": null
}Kanale
Kanale is die kern kommunikasieprimitiwe. Tipes sluit in Kanaalmense, Kanaalgroep, KanaalKontak, KanaalKontaknommer, KanaalEksternenommer, Kanaaldiens en Kanaalopnemer.
Kommunikasie
Inisieer en bestuur aktiewe kommunikasiesessies — uitgaande oproepe, VCP, opnames en inhoudstroming. Die uitgaande-maak-respons sluit 'n CBBPMessage in waarop die toestel onmiddellik reageer.
Oudiobrug
Kry toegang tot opgeneemde bruggesprekke, insluitend volledige transkripsies, deelnemerslyste en KI-gegenereerde opsommings. Ondersteun verskeie opsommingsjablone (vergaderingnotas, klasnotas, gesondheidsorg, ens.) en TTS-klankgenerering vir opsommings.
Gesprekke
KI-aangedrewe gespreksessies met behulp van ChatGPT, Gemini of die oorspronklike enjin. Ondersteun verskeie personas (Dokter, Tutor, Werktuigkundige, ens.) en gebladsyde boodskapgeskiedenis.
Inhoud
Blaai deur en speel stroom-klankinhoud op toestelle. Inhoud word in 'n kategorieboom georganiseer; gewilde inhoud kan volgens stad, streek of land gefiltreer word.
Liggings
Los geografiese koördinate op vir 'n gestruktureerde stad-, streek- en landobjek. Gebruik deur toestelle wanneer konteks ingeneem word.
Stootkennisgewings
Registreer 'n mobiele toepassing om FCM-stootkennisgewings te ontvang. Ondersteun iOS-, Android- en webteikens.
Berging
Laai lêers wat op modelvoorwerpe gestoor is, af en voer die verwydering van beeldagtergrond uit (lewer base64-geënkodeerde resultaat terug).
Grootmaatbedrywighede
Voer verskeie API-bewerkings in 'n enkele HTTP-versoek uit. Gee single_transaction=true om alle bewerkings in een atoomtransaksie toe te draai — 'n mislukking op enige item rol die hele bondel terug.
Datum en tyd
Gee die huidige bedienerdatum en -tyd in GMT+0 terug. Vereis nie verifikasie nie. Word deur toestelle gebruik om hul interne klok te sinkroniseer.
Basiese Protokol vir Com Badge
CBBP is 'n liggewig JSON-opdragprotokol vir direkte interaksie met verbindingskentekens. Dit gee jou volle beheer oor elke hardeware- en sagtewarefunksie op die toestel.
Boodskapformaat
Elke CBBP-interaksie bestaan uit 'n opdragboodskap wat na die toestel gestuur word en 'n resultaatboodskap wat deur die toestel teruggestuur word.
Die objekveld in beide versoek en reaksie dra opdragspesifieke data en kan weggelaat word wanneer dit nie nodig is nie.
{
"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
}
}Vervoer
CBBP-boodskappe kan deur drie verskillende vervoerdienste aan 'n kenteken afgelewer word, afhangende van jou integrasie-argitektuur.
Bluetooth (App)
Stuur CBBP-opdragte direk vanaf 'n mobiele toepassing oor BLE. Vereis dat die toestel gekoppel en binne bereik is.
Mobiele SDKWiFi of Bluetooth via bediener
Proxy CBBP deur die REST API — POST /devices//cbbp. Die bediener stuur outomaties na die toestel oor WiFi of Bluetooth, afhangende van hoe die kenteken gekoppel is. Mees algemeen vir backend-integrasies.
REST APIInterne Versending
CBBP-versending op toestel of tussen prosesse. Gebruik deur die kenteken-firmware om bevele tussen interne substelsels te roeteer.
Slegs firmwareKragbevele
Beheer toestel se kragtoestand — slaap, wakker word, herlaai en fabrieksherstel.
WiFi-opdragte
Konfigureer draadlose netwerke, skandeer vir AP's, kontroleer verbindingstatus en bestuur gestoorde geloofsbriewe.
Bluetooth-opdragte
Beheer BLE-advertensies, paring en kenteken-tot-kenteken-kommunikasie.
Instellingsopdragte
Lees en skryf toestelkonfigurasie — vertoonnaam, tydsone, taal en kenmerkvlae.
Firmware-opdragte
Aktiveer OTA-firmware-opdaterings, kontroleer opdateringsstatus en vra die huidige firmware-weergawe op die toestel.
Toestelbevele
Toestellewensiklus, verifikasie, konfigurasie, logging, status en hardewarebeheer.
Kommunikasiebevele
Begin oproepe, stuur boodskappe, bestuur aktiewe kommunikasiesessies en beheer opnames.
Oudio-opdragte
Beheer luidsprekervolume, mikrofoonversterking, oudioprofiele en teks-na-spraak-terugspeel.
LED-opdragte
Stel LED-kleur, helderheid en animasiepatrone op die kenteken-aanwyserlig.
Interne bevele
Interne versendingsbevele wat gebruik word vir kontekslewering, kanaalgeskiedenis, vokalisering en oudiodekodering.
Mobiele bevele
Opdragte vir die koördinering van die kenteken met 'n gekoppelde mobiele toepassing — stootkennisgewings, toepassingstatus-sinkronisering en diep skakeling.