Auðkenning
Tengingarforritaskilið notar auðkenningu með Bearer-tákni. Allar beiðnir verða að innihalda gilt JWT-aðgangstákn í heimildarhausnum.
Fáðu tákn
SENDU innskráningarupplýsingar þínar á auth-endapunktinn. Þú munt fá aðgangsmerki með stuttum líftíma og endurnýjunarmerki með lengri líftíma.
Notaðu táknið
Hafðu táknið með í hverri beiðni:
{
"email": "admin@yourorg.com",
"password": "••••••••"
}{
"access_token": "eyJhbG...",
"refresh_token": "dGhpcw...",
"expires_in": 3600,
"token_type": "Bearer"
}Grunnslóð og útgáfustjórnun
Allir API-endapunktar eru útgáfustýrðir undir /api/v1/. Grunnslóðin fer eftir uppsetningu þinni.
Fyrir skýjahýstar dreifingar skal nota svæðisbundna endapunktinn sem fyrirtækinu þínu er úthlutað. Fyrir staðbundnar netþjónsdreifingar skal nota hýsingarheiti netþjónsins.
| Umhverfi | Grunnslóð |
|---|---|
| Ský (Bandaríkin) | https://beta.connection.app/api/v1 |
| Á staðnum | https://<your-server>/api/v1 |
Öll beiðni- og svarstexti nota application/json. Hafið Content-Type: application/json með í beiðnum með texta.
Villur og stöðukóðar
Forritaskilið notar staðlaða HTTP stöðukóða. Villusvörun inniheldur véllesanlegan kóða og skilaboð sem manna lesa.
| Staða | Merking |
|---|---|
| 200 | Árangur |
| 201 | Búið til |
| 400 | Ógild beiðni — ógildar breytur |
| 401 | Óheimilt — týnt eða útrunnið tákn |
| 403 | Bannað — ófullnægjandi heimildir |
| 404 | Ekki fannst |
| 500 | Innri villa á netþjóni |
{
"error": {
"code": "device_not_found",
"message": "No device with that UUID exists in your organization",
"status": 404
}
}Yfirlit yfir REST API
REST API-forritaskilið fyrir tengingarþjóninn veitir fullan forritunaraðgang að tækjaflota þínum, samskiptainnviðum og greiningum. Það fylgir RESTful-venjum með JSON-beiðnum/svörunum.
Auðkenning
Auðkenning byggð á táknum. Innskráning skilar tákni sem verður að senda sem Heimild: Tákn.<token> á allar síðari beiðnir.
Notendur
Búa til og stjórna notendareikningum. GET /users/user endapunkturinn skilar þeim notanda sem er nú auðkenndur.
Tæki
Lista og skoða tæki, stjórna tengingum notenda og tækja, lesa og skrifa stillingar og stöðu fyrir hvert tæki, meðhöndla vélbúnaðar- og geymslumyndir og taka á móti skrám og hrunskýrslum.
CBBP-umboð
Senda hvaða CBBP skipun sem er til tækis í gegnum netþjóninn. Netþjónninn sendir skipunina yfir WiFi tengingu tækisins og skilar svari tækisins. Útsendandi „make“ svarið felur einnig inn CBBPMessage sem tækið keyrir strax.
Beiðnin er CBBP skipunarumslag. Geymda CBBPCommand hluturinn rekur afhendingarstöðu: ÓSETT → SENT → MÓTTEKIÐ eða TIMED_OUT.
{
"outgoingMessage": {
"command": "WiFiScan"
}
}{
"uuid": "a3f2...",
"status": "SENT",
"device": "d7f3a1b2-...",
"dateSent": "2025-09-15T14:22:01Z",
"outgoingMessage": { /* echoed */ },
"incomingMessage": null
}Rásir
Rásir eru kjarnafrumþættir samskipta. Tegundir þeirra eru meðal annars ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService og ChannelRecorder.
Samskipti
Hefja og stjórna virkum samskiptalotum — úthringingum, VCP, upptökum og streymi efnis. Svarið við úthringingum inniheldur CBBPMessage sem tækið bregst strax við.
Hljóðbrú
Aðgangur að upptökum af samtölum í brúnni, þar á meðal fullum afritum, þátttakendalistum og samantektum sem eru búnar til með gervigreind. Styður margvísleg sniðmát fyrir samantektir (fundarglósur, tímaritsglósur, heilbrigðisgögn o.s.frv.) og TTS hljóðframleiðslu fyrir samantektir.
Samtöl
Gervigreindarknúnar samræður með ChatGPT, Gemini eða innbyggðu Chatvélinni. Styður margar persónur (lækni, einkakennara, vélvirkja o.s.frv.) og síðuskipta skilaboðasögu.
Efni
Skoðaðu og spilaðu streymandi hljóðefni á tækjum. Efni er skipulagt í flokkatré; vinsælt efni er hægt að sía eftir borg, svæði eða landi.
Staðsetningar
Leysa upp landfræðileg hnit fyrir skipulögð borgar-, svæðis- og landshlut. Notað af tækjum við inntöku samhengis.
Tilkynningar
Skráðu þig í smáforrit til að fá FCM tilkynningar. Styður iOS, Android og vefviðmót.
Geymsla
Hlaðið niður skrám sem eru geymdar á líkanhlutum og keyrið fjarlægingu bakgrunns myndar (skilar base64-kóðaðri niðurstöðu).
Magnaðgerðir
Framkvæma margar API aðgerðir í einni HTTP beiðni. Senda single_transaction=true til að vefja öllum aðgerðum í eina atómfærslu — bilun í einhverju atriði afturkallar allan hópinn.
Dagsetning og tími
Skilar núverandi dagsetningu og tíma netþjónsins í GMT+0. Krefst ekki auðkenningar. Notað af tækjum til að samstilla innri klukku sína.
Grunnreglur um Com Badge
CBBP er létt JSON skipanasamskiptaregla fyrir bein samskipti við tengingarmerki. Hún veitir þér fulla stjórn á öllum vélbúnaðar- og hugbúnaðarvirkni tækisins.
Skilaboðasnið
Sérhver CBBP-samskipti samanstanda af skipunarskilaboðum sem send eru til tækisins og niðurstöðuskilaboðum sem tækið skilar.
Hlutarreiturinn, bæði í beiðni og svari, inniheldur skipunarsértæk gögn og má sleppa honum þegar hann er ekki nauðsynlegur.
{
"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
}
}Samgöngur
Hægt er að afhenda CBBP-skilaboð til merkis með þremur mismunandi flutningum eftir því hvaða samþættingararkitektúr þú notar.
Bluetooth (forrit)
Senda CBBP skipanir beint úr farsímaforriti í gegnum BLE. Krefst þess að tækið sé parað og innan seilingar.
FarsímaforritunarverkfæriWiFi eða Bluetooth í gegnum netþjón
Staðfesta CBBP í gegnum REST API — POST /devices//cbbp. Þjónninn sendir sjálfkrafa gögn til tækisins í gegnum WiFi eða Bluetooth, allt eftir því hvernig merkið er tengt. Algengast fyrir bakendasamþættingar.
REST APIInnri sending
CBBP-sending á tæki eða milli ferla. Notað af vélbúnaði merkisins til að beina skipunum milli innri undirkerfa.
Aðeins vélbúnaðarKraftskipanir
Stjórna stöðu tækisins — svefn, vekja, endurræsa og núllstilla verksmiðjustillingar.
WiFi skipanir
Stilltu þráðlaus net, leitaðu að aðgangsstöðum, athugaðu stöðu tenginga og stjórnaðu vistuðum innskráningarupplýsingum.
Bluetooth skipanir
Stjórna BLE-auglýsingum, pörun og samskiptum milli merkja.
Stillingarskipanir
Lesa og skrifa stillingar tækja — birtingarheiti, tímabelti, tungumál og eiginleikamerki.
Fastbúnaðarskipanir
Virkjaðu OTA vélbúnaðaruppfærslur, athugaðu stöðu uppfærslu og spurðu um núverandi vélbúnaðarútgáfu tækisins.
Tækjaskipanir
Líftími tækis, auðkenning, stilling, skráning, staða og vélbúnaðarstjórnun.
Samskiptaskipanir
Hringdu í símtöl, sendu skilaboð, stjórnaðu virkum samskiptalotum og stjórnaðu upptökum.
Hljóðskipanir
Stjórnaðu hljóðstyrk hátalara, styrk hljóðnema, hljóðprófílum og spilun texta-í-tal.
LED skipanir
Stilltu lit, birtustig og hreyfimyndamynstur LED-ljóssins á vísirljósinu á merkinu.
Innri skipanir
Innri sendingarskipanir notaðar til að afhenda samhengi, rásarsögu, raddbeitingu og hljóðafkóðun.
Farsímaskipanir
Skipanir til að samræma merkið við parað farsímaforrit — tilkynningar, samstilling á stöðu forritsins og djúptengingar.