Udviklerplatform

Bygg videre på
Forbindelsesplatform

To kraftfulde API'er — en RESTful server-API til enhedsadministration og kommunikationsorkestrering og en lavniveau-CBBP-protokol til direkte badge-kontrol.

REST API-referenceCBBP-protokol
OpenAPI 3.0JSON / RESTBluetooth + Wi-FiWebhook-understøttelse
Connection Studio
Explorer
examples
send_command.http
response.json
list_devices.http
webhooks.http
src
docs
send_command.http
response.json
# Send a CBBP command via the server
POST /api/v1/devices/{uuid}/cbbp

{
  "command": "speak",
  "object": {
    "text": "Shift starts in 5 minutes",
    "volume": 85,
    "language": "en-US"
  }
}

# Response
{
  "result": 0,
  "detail": "ok"
}
main
HTTPUTF-8Ln 2, Col 1

REST API

Fuld styring af enhedslivscyklus — klargøring, konfiguration, firmware, kommunikation og analyse — via standard HTTPS.

Udforsk REST API →

CBBP-protokol

Com Badge Basic Protocol — en JSON-kommandoprotokol til direkte enhedskontrol via Bluetooth (app), WiFi (serverproxy) eller lokal forsendelse.

Udforsk CBBP →

Webhooks

Abonner på enhedshændelser i realtid – kommunikation, statusændringer, placeringsopdateringer – leveret som HTTP POST-nyttelast til dit slutpunkt.

Udforsk Webhooks →

Early Access: The Connection API is currently available by special request to select partners. Contact us to apply for access.

Pro or Plus plan required: Badges must be on the Pro or Plus plan to be controlled via the API.

Kom godt i gang

Godkendelse

Connection API'en bruger Bearer-token-godkendelse. Alle anmodninger skal indeholde et gyldigt JWT-adgangstoken i Authorization-headeren.

Få en token

Send dine legitimationsoplysninger til godkendelsesslutpunktet. Du modtager et kortlivet access_token og et længerevarende refresh_token.

Brug tokenet

Inkluder tokenet i hver anmodning:

Authorization: Bearer <access_token>
POST/api/v1/auth/login
Anmodning
{
  "email": "admin@yourorg.com",
  "password": "••••••••"
}
Svar 200
{
  "access_token": "eyJhbG...",
  "refresh_token": "dGhpcw...",
  "expires_in": 3600,
  "token_type": "Bearer"
}

Basis-URL og versionsstyring

Alle API-slutpunkter er versioneret under /api/v1/. Basis-URL'en afhænger af din implementering.

For cloud-hostede implementeringer skal du bruge det regionale slutpunkt, der er tildelt din organisation. For lokale serverimplementeringer skal du bruge din servers værtsnavn.

MiljøBasis-URL
Cloud (USA)https://beta.connection.app/api/v1
On-Premiseshttps://<your-server>/api/v1
Indholdstype
Alle anmodnings- og svartekster bruger application/json. Inkluder Content-Type: application/json på anmodninger med en tekst.

Fejl og statuskoder

API'en bruger standard HTTP-statuskoder. Fejlsvar inkluderer en maskinlæsbar kode og en menneskelæsbar besked.

StatusMening
200Succes
201Oprettet
400Dårlig anmodning — ugyldige parametre
401Uautoriseret — manglende eller udløbet token
403Forbudt — utilstrækkelige tilladelser
404Ikke fundet
500Intern serverfejl
Fejlrespons
{
  "error": {
    "code": "device_not_found",
    "message": "No device with that UUID exists in your organization",
    "status": 404
  }
}
REST API

REST API-oversigt

Connection Server REST API'en giver fuld programmatisk adgang til din enhedsflåde, kommunikationsinfrastruktur og analyser. Den følger RESTful-konventioner med JSON-forespørgsels-/svarelementer.

API-godkendelse
Brugere
Enheder
Kanaler
Meddelelse
Lydbro
Samtaler
Tilfreds
Lokationer
Push-notifikationer
Opbevaring
Masseoperationer
Dato og klokkeslæt

Godkendelse

Tokenbaseret godkendelse. Login returnerer et token, der skal sendes som Authorization: Token<token> på alle efterfølgende anmodninger.

POST/api/v1/loginGodkend en bruger og modtag et godkendelsestoken
POST/api/v1/login-deviceGodkend en enhed via UUID og MAC-adresse
POST/api/v1/logoutUgyldiggør den aktuelle sessionstoken

Brugere

Opret og administrer brugerkonti. GET /users/user-slutpunktet returnerer den aktuelt godkendte bruger.

GET/api/v1/users/userHent den brugerprofil, der aktuelt er logget ind
POST/api/v1/users/userOpret en ny brugerkonto
PATCH/api/v1/users/user/{uuid}Opdater brugerprofil (f.eks. profilbillede)

Enheder

Liste og inspicer enheder, administrer bruger-enhedstilknytninger, læs og skriv indstillinger og status pr. enhed, håndter firmware- og lagringsbilleder, og modtag logfiler og nedbrudsrapporter.

GET/api/v1/devices/deviceListe over alle enheder
GET/api/v1/devices/device/{uuid}Få detaljerede enhedsoplysninger, herunder firmware og indstillinger
PUT/api/v1/devices/association/{uuid}Opdater tilknytningen mellem en bruger og en enhed
DELETE/api/v1/devices/association/{uuid}Fjern bruger-enhedstilknytning og gemte indstillinger
GET/api/v1/devices/device/{device_uuid}/settingsListe over indstillinger gemt for en enhed
POST/api/v1/devices/device/{device_uuid}/settingsGem enhedsspecifikke indstillinger
GET/api/v1/devices/device/{device_uuid}/statusFå enhedsstatus (forbindelse, batteri, sensorer, lydstatus)
POST/api/v1/devices/device/{device_uuid}/statusOpslå enhedsstatus fra enheden
GET/api/v1/devices/device/{device_uuid}/contextListe over kontekstværdier gemt for en enhed
POST/api/v1/devices/device/{device_uuid}/ingest-contextModtag GPS + WiFi-kontekst fra enheden
GET/api/v1/devices/firmwareListe over firmwareudgivelser, der er kompatible med en given hardware-/softwareversion
GET/api/v1/devices/firmware/{uuid}/{image_type}/fetchHent et firmwarebillede i bidder
GET/api/v1/devices/languageListe over understøttede enhedssprog og stemmer
GET/api/v1/devices/storage_imageDownload et brugerdefineret enhedslagringsbillede for en lokalitet
POST/api/v1/devices/logModtag en logfil fra en enhed
POST/api/v1/devices/crashModtag en core dump fra en enhed
PATCH/api/v1/devices/crash/{uuid}Opdater en nedbrudsregistrering

CBBP-proxy

Send en hvilken som helst CBBP-kommando til en enhed via serveren. Serveren videresender kommandoen via enhedens WiFi-forbindelse og returnerer enhedens svar. Det udgående make-svar integrerer også en CBBPMessage, som enheden udfører med det samme.

POST/api/v1/devices/device/{device_uuid}/cbbpSend en CBBP-kommando til en enhed via serveren
GET/api/v1/devices/device/{device_uuid}/cbbp/{uuid}Hent status og svar på en tidligere sendt CBBP-kommando

Anmodningsteksten er en CBBP-kommandokonvolut. Det gemte CBBPCommand-objekt sporer leveringsstatus: UNSET → SENT → RECEIVED eller TIMED_OUT.

Udfør en afstemning med GET /cbbp/ for at kontrollere, om enheden modtog og reagerede på kommandoen.
Anmodning — udgående besked
{
  "outgoingMessage": {
    "command": "WiFiScan"
  }
}
Svar — CBBP-kommandostatus
{
  "uuid": "a3f2...",
  "status": "SENT",
  "device": "d7f3a1b2-...",
  "dateSent": "2025-09-15T14:22:01Z",
  "outgoingMessage": { /* echoed */ },
  "incomingMessage": null
}

Kanaler

Kanaler er de centrale kommunikationsprimitiver. Typerne omfatter ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService og ChannelRecorder.

GET/api/v1/channels/channelListe over kanaler, eventuelt filtreret efter objekttype
POST/api/v1/channels/channelOpret en kanal (Kanalgruppe, Kanalkontakt eller Kanaleksterntnummer)
PATCH/api/v1/channels/channel/{uuid}Opdater en kanalgruppe eller kanalkontakt
DELETE/api/v1/channels/channel/{uuid}Slet en kanal
DELETE/api/v1/channels/{uuid}Slet en kanalgruppe
DELETE/api/v1/channels/by-type/{channelType}Slet alle kanaler af en given type (i øjeblikket Kanalkontakt)
GET/api/v1/channels/associationVis kanaltilknytninger for den aktuelle bruger
POST/api/v1/channels/associationAnmod om en tilknytning til en kanal
PATCH/api/v1/channels/association/{uuid}Accepter, afvis eller opdater tilknytningsindstillinger
DELETE/api/v1/channels/association/{uuid}Fjern en tilknytning til en kanal
GET/api/v1/channels/historyHent pagineret kanaladgangshistorik for den aktuelle bruger
POST/api/v1/channels/historyOpret en kanalhistorikpost
GET/api/v1/channels/searchSøg i kanaler efter forespørgselsstreng og valgfrit typefilter

Meddelelse

Start og administrer aktive kommunikationssessioner — udgående opkald, VCP, optagelse og streaming af indhold. Det udgående opkaldssvar inkluderer en CBBPMessage, som enheden reagerer på med det samme.

POST/api/v1/communicate/outgoing-makeStart en udgående kanal til en ChannelPeople, ChannelGroup, ChannelContact eller ChannelContactNumber
POST/api/v1/communicate/incoming-acceptanceAccepter eller afvis en indgående anmodning om kanaltilmelding
POST/api/v1/communicate/closeLuk den aktuelle aktive kommunikationskanal på en enhed
POST/api/v1/communicate/vcp-activateStart Voice Communication Protocol (VCP) på serveren og enheden
POST/api/v1/communicate/vcp-deactivateDeaktiver VCP, og vend tilbage til enhver forrige kanal
POST/api/v1/communicate/recording-activateAktivér optagetilstand på serveren og enheden
POST/api/v1/communicate/content-startÅbn en streamingkanal til lydindhold
POST/api/v1/communicate/request-vocalizationGenerer TTS-lyd til den givne tekst, eventuelt oversæt den

Lydbro

Få adgang til optagede bridge-samtaler, inklusive fulde transskriptioner, deltagerlister og AI-genererede resuméer. Understøtter flere resuméskabeloner (mødenotter, klassenotater, sundhedspleje osv.) og TTS-lydgenerering til resuméer.

GET/api/v1/bridge/conversationsListe over alle bridge-samtaler
GET/api/v1/bridge/conversations/{uuid}Få en detaljeret samtale inklusive transskription, deltagere og resumé
POST/api/v1/bridge/conversations/{conversation_uuid}/summaryGenerer et AI-resumé for en samtale
POST/api/v1/bridge/conversations/{conversation_uuid}/summary/{summary_uuid}/audioGenerer lyd til et samtaleopsummering

Samtaler

AI-drevne samtalesessioner ved hjælp af ChatGPT, Gemini eller den native motor. Understøtter flere personaer (læge, underviser, mekaniker osv.) og pagineret beskedhistorik.

GET/api/v1/conversations/conversationListe over AI-generatorsessioner, filtrerbar efter persona og værktøj
POST/api/v1/conversations/conversationOpret en ny AI-samtalesession
GET/api/v1/conversations/conversation/{uuid}Hent en samtalesession med valgfri opsummering/opdatering om fravær
DELETE/api/v1/conversations/conversation/{uuid}Slet en samtalesession
GET/api/v1/conversations/conversation/{uuid}/messagesListe over beskeder i en samtale
POST/api/v1/conversations/conversation/{uuid}/messagesTilføj en brugerbesked og modtag et AI-svar

Tilfreds

Gennemse og afspil streaming af lydindhold på enheder. Indholdet er organiseret i et kategoritræ; populært indhold kan filtreres efter by, region eller land.

GET/api/v1/content/categoriesFå et træ over indholdskategorier
GET/api/v1/content/contentListe over tilgængeligt indhold inden for en kategori
GET/api/v1/content/popularListe over populært indhold for en given by, region eller land

Lokationer

Opløs geografiske koordinater til et struktureret by-, region- og landsobjekt. Bruges af enheder ved indtagelse af kontekst.

POST/api/v1/location/determineOpløs en breddegrad/længdegrad til by, region og land

Push-notifikationer

Registrer en mobilapp for at modtage FCM push-notifikationer. Understøtter iOS, Android og webmål.

POST/api/v1/push-notifications/pushRegistrer en mobilapp til FCM push-notifikationer (iOS, Android, web)

Opbevaring

Download filer gemt på modelobjekter, og kør fjernelse af billedets baggrund (returnerer base64-kodet resultat).

GET/api/v1/storage/retrieve/{path}Download en gemt fil via sti
POST/api/v1/storage/remove-backgroundFjern baggrunden fra et billede (returnerer base64)

Masseoperationer

Udfør flere API-operationer i en enkelt HTTP-anmodning. Send single_transaction=true for at pakke alle operationer ind i én atomtransaktion — en fejl på et element ruller hele batchen tilbage.

POST/api/v1/bulkUdfør flere API-operationer i en enkelt anmodning, eventuelt som en enkelt atomtransaktion

Dato og klokkeslæt

Returnerer den aktuelle serverdato og -klokkeslæt i GMT+0. Kræver ikke godkendelse. Bruges af enheder til at synkronisere deres interne ur.

GET/api/v1/current-datetimeReturner den aktuelle dato og tid i GMT+0
CBBP-protokol

Grundlæggende protokol for Com Badge

CBBP er en let JSON-kommandoprotokol til direkte interaktion med forbindelsesbadges. Den giver dig fuld kontrol over alle hardware- og softwarefunktioner på enheden.

Meddelelsesformat

Enhver CBBP-interaktion består af en kommandobesked, der sendes til enheden, og en resultatbesked, der returneres af enheden.

Objektfeltet i både anmodning og svar indeholder kommandospecifikke data og kan udelades, når det ikke er nødvendigt.

Fuld protokoldokumentation er tilgængelig for registrerede partnere. Kontakt din Connection-repræsentant, eller kontakt os developer@connectionbadge.com at anmode om adgang til den komplette CBBP-kommandoreference, inklusive komplette anmodnings-/svarskemaer, fejlkoder og integrationsvejledninger.
Kommandomeddelelse
{
  "command": "command_name",
  "object": {
    // optional command parameters
  }
}
Resultatmeddelelse
{
  "result": 0,          // 0 = success, -1 = error
  "detail": "ok",      // human-readable status
  "object": {          // optional response data
    // command-specific fields
  }
}

Transportere

CBBP-meddelelser kan leveres til en badge via tre forskellige transporter afhængigt af din integrationsarkitektur.

Bluetooth (App)

Send CBBP-kommandoer direkte fra en mobilapp via BLE. Kræver, at enheden er parret og inden for rækkevidde.

Mobil SDK

WiFi eller Bluetooth via server

Proxy CBBP via REST API — POST /devices//cbbp. Serveren dirigerer automatisk til enheden via WiFi eller Bluetooth afhængigt af hvordan badget er tilsluttet. Mest almindeligt for backend-integrationer.

REST API

Intern forsendelse

CBBP-afsendelse på enhed eller mellem processer. Bruges af badge-firmwaren til at sende kommandoer mellem interne undersystemer.

Kun firmware

Power-kommandoer

Styr enhedens strømtilstand — dvaletilstand, vækning, genstart og fabriksnulstilling.

PowerRebootGenstart enheden med det samme.
PowerDeepsleepGå ind i dyb dvaletilstand (lavt strømforbrug).
FactoryResetSlet al konfiguration og nulstil til fabriksindstillingerne.

WiFi-kommandoer

Konfigurer trådløse netværk, scan efter AP'er, kontroller forbindelsesstatus og administrer gemte legitimationsoplysninger.

WiFiScanSøg efter tilgængelige WiFi-adgangspunkter.
WiFiAPTestTest forbindelsen til et specifikt WiFi-adgangspunkt.
WiFiAPJoinOpret forbindelse til et WiFi-adgangspunkt med de angivne loginoplysninger.

Bluetooth-kommandoer

Styr BLE-annoncering, parring og kommunikation mellem badges.

BTScanBTScan efter klassiske Bluetooth-enheder.
BTScanBLEScan efter BLE-enheder.
DeviceBLEServiceAvailableMarkér BLE-tjenesten som tilgængelig.
DeviceBLEServiceUnavailableMarkér BLE-tjenesten som utilgængelig.
DeviceBLEActiveIndstil BLE-radioen til aktiv tilstand.
DeviceBLEIdleSæt BLE-radioen i inaktiv tilstand.
DeviceBLEAdvChannelAddTilføj en kanal til BLE-annoncenyttelasten.
DeviceBTScanStart en scanning af Bluetooth-enheder.
DeviceBTA2DStartStart Bluetooth A2DP-lydstreaming.
DeviceBTA2DEndAfslut Bluetooth A2DP-lydstreaming.
DeviceBTNativeAssistStartStart den indbyggede Bluetooth-stemmeassistent.
DeviceBTNativeAssistEndAfslut den indbyggede Bluetooth-stemmeassistent.

Indstillingskommandoer

Læs og skriv enhedskonfiguration — visningsnavn, tidszone, sprog og funktionsflag.

SettingsListGetHent alle indstillinger som en nøgleværdiliste.
SettingsListSetSkriv flere indstillingsværdier på én gang.
SettingsGetHent værdien af en enkelt indstilling med nøgle.
SettingsSetAngiv værdien for en enkelt indstilling.
SettingsSendSend aktuelle indstillinger til serveren.
SettingsClearRyd specifikke indstillingsværdier.
SettingsEraseSlet alle gemte indstillinger.

Firmware-kommandoer

Udløs OTA-firmwareopdateringer, tjek opdateringsstatus, og forespørg om den aktuelle firmwareversion på enheden.

FirmwareCheckKontroller, om en firmwareopdatering er tilgængelig.
FirmwareUpdateStart en OTA-firmwareopdatering.
FirmwareValidateValider integriteten af et downloadet firmwarebillede.

Enhedskommandoer

Enhedens livscyklus, godkendelse, konfiguration, logføring, status og hardwarekontrol.

NoOpIngen drift / keep-alive.
TestGrundlæggende forbindelsestest.
DeviceDateTimeHent eller indstil enhedens dato og klokkeslæt.
DeviceAuthenticateGodkend enheden med serveren.
DeviceConfigureAnvend en konfigurationsnyttelast på enheden.
DevicePostConnectionTasksKør initialiseringsopgaver efter forbindelse.
DeviceStorageLoadIndlæs data fra enhedens lager.
DeviceLoadCustomAudioIndlæs brugerdefinerede lydfiler på enheden.
DeviceCoredumpSendUpload en crash core dump til serveren.
DeviceAttachTilslut enheden til en serversession.
DeviceDetachAfbryd enheden fra en serversession.
DeviceLogSendUpload enhedslogfiler til serveren.
DeviceConnectionTestTest serverforbindelse.
DeviceStatusSendSend enhedsstatus til serveren.
DeviceStatusGetFå den aktuelle enhedsstatus.
DeviceInteractionUdløs en enhedsinteraktionshændelse.
DeviceSetAPIHostAngiv API-serverværten.
DeviceTestMicsKør en selvtest af mikrofonen.
HardwareI2CCommandSend en rå I2C-kommando til en hardwareperiferienhed.

Kommunikationskommandoer

Start opkald, send beskeder, administrer aktive kommunikationssessioner og styr optagelse.

CommunicateChannelJoinDeltag i en kommunikationskanal.
CommunicateChannelLeaveEfterlad en kommunikationskanal.
CommunicateChannelChangeSkift til en anden kanal.
CommunicateChannelCloseLuk en kommunikationskanal.
CommunicateReceiveIncomingGiv enheden besked om indgående kommunikation.
CommunicateRequestOutgoingAnmod om udgående kommunikation.
CommunicateVCPActivateAktiver stemmekommunikationsprotokolsessionen.
CommunicateVCPDeactivateDeaktiver VCP-sessionen.
CommunicateRecordingActivateStart optagelsen af den aktive kommunikation.
CommunicateIncomingAcceptAccepter et indgående opkald.
CommunicateIncomingRejectAfvis et indgående opkald.
CommunicateHFPCallStartStart et Bluetooth HFP-telefonopkald.
CommunicateHFPCallEndAfslut et Bluetooth HFP-telefonopkald.
CommunicateContentStartBegynd at streame lydindhold til enheden.
CommunicateContentStopStop streaming af lydindhold.
SocketReceiveStatusModtag en WebSocket-statusopdatering.

Lydkommandoer

Styr højttalerlydstyrke, mikrofonforstærkning, lydprofiler og tekst-til-tale-afspilning.

AudioPlayStorageAfspil en lydfil fra enhedens lager.
AudioPlayContentAfspil streamet lydindhold.
AudioSetVolumeIndstil højttalerens udgangslydstyrke.

LED-kommandoer

Indstil LED-farve, lysstyrke og animationsmønstre på badge-indikatorlampen.

DeviceIlluminationSetIndstil LED-farven og belysningsmønsteret.

Interne kommandoer

Interne afsendelseskommandoer brugt til kontekstlevering, kanalhistorik, vokalisering og lydafkodning.

InternalSendContextSend kontekstdata til den interne kontekstbehandler.
InternalSendChannelHistorySend kanalhistorik til den interne handler.
InternalRequestVocalizationAnmod om tekst-til-tale-vokalisering internt.
InternalHandleVocalizationRTPHåndter en indgående vokaliserings-RTP-stream.
InternalDecodeAudioAfkode en indgående lydstrøm.

Mobilkommandoer

Kommandoer til koordinering af badget med en parret mobilapp — push-notifikationer, synkronisering af apptilstand og dybe links.

MobileServiceStatusRapportér status for mobiltjenesten til enheden. (Mobil → Enhed)
MobileSocketOpenInstruer mobilappen til at åbne en WebSocket-forbindelse. (Enhed → Mobil)
MobileSocketCloseInstruer mobilappen til at lukke en WebSocket-forbindelse. (Enhed → Mobil)
MobileSocketStatusRapportér WebSocket-status til mobilappen. (Enhed → Mobil)
MobileReceiveStatusRapportér modtagelsesstatus til mobilappen. (Enhed → Mobil)
MobileSocketUpdateSend en WebSocket-dataopdatering til mobilappen. (Enhed → Mobil)
MobilePTTStartGiv mobilappen besked om, at PTT-transmissionen er startet. (Enhed → Mobil)
MobilePTTStopGiv mobilappen besked om, at PTT-transmissionen er afsluttet. (Enhed → Mobil)
MobileContextSetIndstil kontekstdata på mobilappen. (Enhed → Mobil)
MobileEchoEcho-kommando til test af mobilforbindelse. (Enhed → Mobil)

Klar til at bygge?

Bliv en del af Connection-udviklerfællesskabet, og få adgang til sandbox-enheder, SDK'er og dedikeret support.

Kontakt os