Developer API — Connection

Bir jeton alın

Kimlik bilgilerinizi auth uç noktasına POST edin. Kısa süreli bir access_token ve daha uzun süreli bir refresh_token alacaksınız.

Jetonu kullanın

Her istekte belirteci (token) ekleyin:

Authorization: Bearer <access_token>

POST/api/v1/auth/login

Rica etmek

{
  "email": "admin@yourorg.com",
  "password": "••••••••"
}

Yanıt 200

{
  "access_token": "eyJhbG...",
  "refresh_token": "dGhpcw...",
  "expires_in": 3600,
  "token_type": "Bearer"
}

Bulut tabanlı dağıtımlar için, kuruluşunuza atanmış bölgesel uç noktayı kullanın. Şirket içi sunucu dağıtımları için, sunucunuzun ana bilgisayar adını kullanın.

Çevre	Temel URL
Bulut (ABD)	`https://beta.connection.app/api/v1`
Yerinde	`https://<your-server>/api/v1`

İçerik Türü
Tüm istek ve yanıt gövdeleri application/json kullanır. Gövde içeren isteklere Content-Type: application/json ekleyin.

Durum	Anlam
200	Başarı
201	Oluşturuldu
400	Hatalı İstek — geçersiz parametreler
401	Yetkisiz — eksik veya süresi dolmuş belirteç
403	Yasaklandı — Yetersiz izinler
404	Bulunamadı
500	İç Sunucu Hatası

Hata Yanıtı

{
  "error": {
    "code": "device_not_found",
    "message": "No device with that UUID exists in your organization",
    "status": 404
  }
}

API Kimlik Doğrulaması

Kullanıcılar

Cihazlar

Kanallar

İletişim

Ses Köprüsü

Konuşmalar

İçerik

Konumlar

Anlık Bildirimler

Depolamak

Toplu İşlemler

Tarih ve Saat

POST/api/v1/loginKullanıcının kimliğini doğrulayın ve bir kimlik doğrulama belirteci alın.

POST/api/v1/login-deviceBir cihazın kimliğini UUID ve MAC adresiyle doğrulayın.

POST/api/v1/logoutGeçerli oturum belirtecini geçersiz kılın.

GET/api/v1/users/userŞu anda oturum açmış olan kullanıcının profilini alın.

POST/api/v1/users/userYeni bir kullanıcı hesabı oluşturun

PATCH/api/v1/users/user/{uuid}Kullanıcı profilini güncelle (örneğin profil resmi)

GET/api/v1/devices/deviceTüm cihazları listele

GET/api/v1/devices/device/{uuid}Cihazınızla ilgili ayrıntılı bilgilere, yazılım sürümüne ve ayarlara ulaşın.

PUT/api/v1/devices/association/{uuid}Kullanıcı ile cihaz arasındaki ilişkiyi güncelleyin.

DELETE/api/v1/devices/association/{uuid}Kullanıcı-cihaz ilişkisini ve kaydedilmiş ayarları kaldırın.

GET/api/v1/devices/device/{device_uuid}/settingsBir cihaz için saklanan ayarları listele.

POST/api/v1/devices/device/{device_uuid}/settingsCihaza özgü ayarları kaydedin

GET/api/v1/devices/device/{device_uuid}/statusCihazın durumunu öğrenin (bağlantı, pil, sensörler, ses durumu)

POST/api/v1/devices/device/{device_uuid}/statusCihazdan cihaz durumunu gönder

GET/api/v1/devices/device/{device_uuid}/contextBir cihaz için saklanan bağlam değerlerini listeleyin.

POST/api/v1/devices/device/{device_uuid}/ingest-contextCihazdan GPS + WiFi bağlam bilgilerini alın.

GET/api/v1/devices/firmwareBelirtilen donanım/yazılım sürümüyle uyumlu aygıt yazılımı sürümlerini listeleyin.

GET/api/v1/devices/firmware/{uuid}/{image_type}/fetchÜrün yazılımı görüntüsünü parçalar halinde indir

GET/api/v1/devices/languageDesteklenen cihaz dilleri ve seslerinin listesi

GET/api/v1/devices/storage_imageBelirli bir bölge için özelleştirilmiş aygıt depolama görüntüsünü indirin.

POST/api/v1/devices/logCihazdan bir günlük dosyası alın.

POST/api/v1/devices/crashBir aygıttan çekirdek dökümü alın.

PATCH/api/v1/devices/crash/{uuid}Kaza kaydını güncelle

POST/api/v1/devices/device/{device_uuid}/cbbpSunucu aracılığıyla bir cihaza CBBP komutu gönderin.

GET/api/v1/devices/device/{device_uuid}/cbbp/{uuid}Daha önce gönderilen bir CBBP komutunun durumunu ve yanıtını alın.

İstek gövdesi bir CBBP komut zarfıdır. Saklanan CBBPCommand nesnesi teslimat durumunu izler: AYARLANMAMIŞ → GÖNDERİLDİ → ALINDI veya ZAMAN AŞIMI.

Cihazın komutu alıp almadığını ve yanıt verip vermediğini kontrol etmek için GET /cbbp/ isteğini gönderin.

İstek — gidenMesaj

{
  "outgoingMessage": {
    "command": "WiFiScan"
  }
}

Yanıt — CBBPCommand durumu

{
  "uuid": "a3f2...",
  "status": "SENT",
  "device": "d7f3a1b2-...",
  "dateSent": "2025-09-15T14:22:01Z",
  "outgoingMessage": { /* echoed */ },
  "incomingMessage": null
}

GET/api/v1/channels/channelİsteğe bağlı olarak object_type'a göre filtrelenmiş kanal listesi.

POST/api/v1/channels/channelBir kanal oluşturun (ChannelGroup, ChannelContact veya ChannelExternalNumber)

PATCH/api/v1/channels/channel/{uuid}Bir Kanal Grubunu veya Kanal İletişim Kişisini Güncelle

DELETE/api/v1/channels/channel/{uuid}Bir kanalı sil

DELETE/api/v1/channels/{uuid}Bir Kanal Grubunu Sil

DELETE/api/v1/channels/by-type/{channelType}Belirtilen türdeki tüm kanalları silin (şu anda ChannelContact).

GET/api/v1/channels/associationMevcut kullanıcı için kanal ilişkilendirmelerini listeleyin.

POST/api/v1/channels/associationBir kanalla ilişkilendirme isteğinde bulunun

PATCH/api/v1/channels/association/{uuid}İlişki ayarlarını kabul et, reddet veya güncelle

DELETE/api/v1/channels/association/{uuid}Bir kanalla olan ilişkiyi kaldır

GET/api/v1/channels/historyGeçerli kullanıcı için sayfalandırılmış kanal erişim geçmişini alın.

POST/api/v1/channels/historyKanal geçmişine bir giriş oluşturun

GET/api/v1/channels/searchArama kanallarını sorgu dizesi ve isteğe bağlı tür filtresiyle arayın.

POST/api/v1/communicate/outgoing-makeBir ChannelPeople, ChannelGroup, ChannelContact veya ChannelContactNumber'a giden bir kanal başlatın.

POST/api/v1/communicate/incoming-acceptanceGelen kanal katılma isteğini kabul et veya reddet

POST/api/v1/communicate/closeCihazdaki mevcut aktif iletişim kanalını kapatın.

POST/api/v1/communicate/vcp-activateSunucu ve cihaz üzerinde Sesli İletişim Protokolü (VCP) başlatın.

POST/api/v1/communicate/vcp-deactivateVCP'yi devre dışı bırakın ve önceki herhangi bir kanala geri dönün.

POST/api/v1/communicate/recording-activateSunucuda ve cihazda kayıt modunu etkinleştirin.

POST/api/v1/communicate/content-startSes içeriği için bir yayın kanalı açın.

POST/api/v1/communicate/request-vocalizationVerilen metin için isteğe bağlı olarak çevirisini de içeren, metinden sese dönüştürme (TTS) özelliği oluşturun.

GET/api/v1/bridge/conversationsTüm köprü konuşmalarını listeleyin.

GET/api/v1/bridge/conversations/{uuid}Konuşmanın tüm detaylarını, katılımcılarını ve özetini edinin.

POST/api/v1/bridge/conversations/{conversation_uuid}/summaryBir konuşma için yapay zeka özeti oluşturun.

POST/api/v1/bridge/conversations/{conversation_uuid}/summary/{summary_uuid}/audioKonuşma özetine yönelik ses kaydı oluşturun.

GET/api/v1/conversations/conversationKullanıcı kitlesine ve araca göre filtrelenebilen yapay zeka jeneratörü oturumlarının listesi.

POST/api/v1/conversations/conversationYeni bir yapay zeka görüşme oturumu oluşturun

GET/api/v1/conversations/conversation/{uuid}İsteğe bağlı özet/uzakta olma güncellemesiyle birlikte bir konuşma oturumunu alın.

DELETE/api/v1/conversations/conversation/{uuid}Bir konuşma oturumunu silin

GET/api/v1/conversations/conversation/{uuid}/messagesBir konuşmadaki mesajları listele

POST/api/v1/conversations/conversation/{uuid}/messagesKullanıcı mesajı ekleyin ve yapay zekadan yanıt alın.

GET/api/v1/content/categoriesİçerik kategorilerinin bir ağacını edinin.

GET/api/v1/content/contentBir kategori içindeki mevcut içerikleri listeleyin.

GET/api/v1/content/popularBelirli bir şehir, bölge veya ülke için popüler içerikleri listeleyin.

POST/api/v1/location/determineEnlem/boylamı şehir, bölge ve ülke olarak çözümleyin.

POST/api/v1/push-notifications/pushFCM anlık bildirimleri için mobil uygulama kaydı oluşturun (iOS, Android, web)

GET/api/v1/storage/retrieve/{path}Kaydedilmiş bir dosyayı belirtilen yoldan indir

POST/api/v1/storage/remove-backgroundGörüntünün arka planını kaldırır (base64 döndürür)

POST/api/v1/bulkTek bir istekte, isteğe bağlı olarak tek bir atomik işlem olarak birden fazla API işlemini gerçekleştirin.

GET/api/v1/current-datetimeGeçerli tarih ve saati GMT+0 formatında döndürün.

Mesaj Formatı

Her CBBP etkileşimi, cihaza gönderilen bir komut mesajından ve cihaz tarafından döndürülen bir sonuç mesajından oluşur.

Hem istekte hem de yanıtta yer alan "nesne" alanı, komuta özgü veriler içerir ve gerekmediğinde atlanabilir.

Protokolün tüm dokümantasyonu, kayıtlı ortakların kullanımına sunulmuştur. Connection işletme temsilcinizle iletişime geçin veya bize ulaşın. developer@connectionbadge.com CBBP komut referansının tamamına, istek/yanıt şemalarına, hata kodlarına ve entegrasyon kılavuzlarına erişim talebinde bulunmak için.

Komut Mesajı

{
  "command": "command_name",
  "object": {
    // optional command parameters
  }
}

Sonuç Mesajı

{
  "result": 0,          // 0 = success, -1 = error
  "detail": "ok",      // human-readable status
  "object": {          // optional response data
    // command-specific fields
  }
}

Bluetooth (Uygulama)

CBBP komutlarını doğrudan mobil uygulamadan BLE üzerinden gönderin. Cihazın eşleştirilmiş ve menzil içinde olması gerekir.

Mobil SDK

Sunucu üzerinden WiFi veya Bluetooth

CBBP'yi REST API üzerinden proxy olarak çalıştırın — POST /devices//cbbp. Sunucu, rozetin nasıl bağlandığına bağlı olarak WiFi veya Bluetooth üzerinden otomatik olarak cihaza yönlendirme yapar. En yaygın kullanım alanı arka uç entegrasyonlarıdır.

REST API

Dahili Sevk

Cihaz içi veya süreçler arası CBBP gönderimi. Rozet bellenimi tarafından dahili alt sistemler arasında komutları yönlendirmek için kullanılır.

Yalnızca ürün yazılımı

Üzerine inşa edinBağlantı Platformu

REST API

CBBP Protokolü

Web kancaları

Kimlik doğrulama

Bir jeton alın

Jetonu kullanın

Temel URL ve Sürüm Oluşturma

Hatalar ve Durum Kodları

REST API'ye Genel Bakış

Kimlik doğrulama

Kullanıcılar

Cihazlar

CBBP Vekili

Kanallar

İletişim

Ses Köprüsü

Konuşmalar

İçerik

Konumlar

Anlık Bildirimler

Depolamak

Toplu İşlemler

Tarih ve Saat

Com Rozeti Temel Protokolü

Mesaj Formatı

Ulaşım

Bluetooth (Uygulama)

Sunucu üzerinden WiFi veya Bluetooth

Dahili Sevk

Güç Komutları

WiFi Komutları

Bluetooth Komutları

Ayarlar Komutları

Ürün Yazılımı Komutları

Aygıt Komutları

İletişim Komutları

Sesli Komutlar

LED Komutları

Dahili Komutlar

Mobil Komutlar

İnşa etmeye hazır mısınız?

Üzerine inşa edin
Bağlantı Platformu