அங்கீகாரம்
இணைப்பு API, பியரர் டோக்கன் அங்கீகாரத்தைப் பயன்படுத்துகிறது. அனைத்து கோரிக்கைகளிலும், அங்கீகாரத் தலைப்பில் (Authorization header) ஒரு செல்லுபடியாகும் JWT அணுகல் டோக்கன் இடம்பெற்றிருக்க வேண்டும்.
ஒரு டோக்கனைப் பெறுங்கள்
உங்கள் சான்றுகளை அங்கீகார முனையத்திற்கு POST செய்யவும். நீங்கள் குறுகிய கால அணுகல் டோக்கன் (access_token) மற்றும் நீண்ட கால புதுப்பிப்பு டோக்கன் (refresh_token) ஆகியவற்றைப் பெறுவீர்கள்.
டோக்கனைப் பயன்படுத்தவும்
ஒவ்வொரு கோரிக்கையிலும் டோக்கனைச் சேர்க்கவும்:
{
"email": "admin@yourorg.com",
"password": "••••••••"
}{
"access_token": "eyJhbG...",
"refresh_token": "dGhpcw...",
"expires_in": 3600,
"token_type": "Bearer"
}அடிப்படை URL மற்றும் பதிப்பு
அனைத்து API எண்ட்பாயிண்ட்களும் /api/v1/ இன் கீழ் பதிப்பிடப்பட்டுள்ளன. அடிப்படை URL உங்கள் வரிசைப்படுத்தலைப் பொறுத்தது.
கிளவுடில் ஹோஸ்ட் செய்யப்பட்ட நிறுவல்களுக்கு, உங்கள் நிறுவனத்திற்கு ஒதுக்கப்பட்ட பிராந்திய எண்ட்பாயிண்ட்டைப் பயன்படுத்தவும். உள்ளக சர்வர் நிறுவல்களுக்கு, உங்கள் சர்வரின் ஹோஸ்ட்பெயரைப் பயன்படுத்தவும்.
| சுற்றுச்சூழல் | அடிப்படை URL |
|---|---|
| கிளவுட் (அமெரிக்கா) | https://beta.connection.app/api/v1 |
| வளாகத்தில் | https://<your-server>/api/v1 |
அனைத்து கோரிக்கை மற்றும் பதில் உள்ளடக்கங்களும் application/json-ஐப் பயன்படுத்துகின்றன. உள்ளடக்கத்தைக் கொண்ட கோரிக்கைகளில் Content-Type: application/json என்பதைச் சேர்க்கவும்.
பிழைகள் மற்றும் நிலைக் குறியீடுகள்
இந்த API, தரநிலையான HTTP நிலைக் குறியீடுகளைப் பயன்படுத்துகிறது. பிழைப் பதில்களில், கணினியால் படிக்கக்கூடிய குறியீடும் மனிதனால் படிக்கக்கூடிய செய்தியும் அடங்கும்.
| நிலை | பொருள் |
|---|---|
| 200 | வெற்றி |
| 201 | உருவாக்கப்பட்டது |
| 400 | தவறான கோரிக்கை — செல்லாத அளவுருக்கள் |
| 401 | அங்கீகரிக்கப்படாத — டோக்கன் இல்லை அல்லது காலாவதியாகிவிட்டது |
| 403 | தடைசெய்யப்பட்டது — போதிய அனுமதிகள் இல்லை |
| 404 | கண்டுபிடிக்கப்படவில்லை |
| 500 | உள் சேவையகப் பிழை |
{
"error": {
"code": "device_not_found",
"message": "No device with that UUID exists in your organization",
"status": 404
}
}REST API கண்ணோட்டம்
கனெக்ஷன் சர்வர் REST API ஆனது, உங்கள் சாதனத் தொகுப்பு, தகவல் தொடர்பு உள்கட்டமைப்பு மற்றும் பகுப்பாய்வுகளுக்கு முழுமையான நிரல்வழி அணுகலை வழங்குகிறது. இது JSON கோரிக்கை/பதில் உள்ளடக்கங்களுடன் RESTful மரபுகளைப் பின்பற்றுகிறது.
அங்கீகாரம்
டோக்கன் அடிப்படையிலான அங்கீகாரம். உள்நுழைவு ஒரு டோக்கனை வழங்கும், அதை அங்கீகாரமாக அனுப்ப வேண்டும்: டோக்கன்.<token> அடுத்தடுத்த அனைத்து கோரிக்கைகளிலும்.
பயனர்கள்
பயனர் கணக்குகளை உருவாக்கி நிர்வகிக்கவும். GET /users/user எண்ட்பாயிண்ட், தற்போது அங்கீகரிக்கப்பட்ட பயனரை வழங்கும்.
சாதனங்கள்
சாதனங்களைப் பட்டியலிட்டு ஆய்வு செய்தல், பயனர்-சாதனத் தொடர்புகளை நிர்வகித்தல், ஒவ்வொரு சாதனத்தின் அமைப்புகளையும் நிலையையும் படித்தல் மற்றும் எழுதுதல், ஃபார்ம்வேர் மற்றும் சேமிப்பகப் படிமங்களைக் கையாளுதல், மேலும் பதிவுகள் மற்றும் செயலிழப்பு அறிக்கைகளைப் பெறுதல்.
CBBP ப்ராக்ஸி
சேவையகம் வழியாக ஒரு சாதனத்திற்கு ஏதேனும் ஒரு CBBP கட்டளையை அனுப்பவும். சேவையகம், சாதனத்தின் WiFi இணைப்பு வழியாக அந்தக் கட்டளையை அனுப்பி, சாதனத்தின் பதிலை திருப்பி அனுப்பும். அனுப்பப்படும் அந்தப் பதிலில், சாதனம் உடனடியாகச் செயல்படுத்தும் ஒரு CBBPMessage-ம் உட்பொதிக்கப்பட்டிருக்கும்.
கோரிக்கை அமைப்பு என்பது ஒரு CBBP கட்டளை உறை ஆகும். சேமிக்கப்பட்ட CBBPCommand பொருள், அனுப்பீட்டு நிலையை UNSET → SENT → RECEIVED அல்லது TIMED_OUT எனக் கண்காணிக்கிறது.
{
"outgoingMessage": {
"command": "WiFiScan"
}
}{
"uuid": "a3f2...",
"status": "SENT",
"device": "d7f3a1b2-...",
"dateSent": "2025-09-15T14:22:01Z",
"outgoingMessage": { /* echoed */ },
"incomingMessage": null
}சேனல்கள்
சேனல்கள் என்பவை தகவல்தொடர்பின் அடிப்படைக் கூறுகளாகும். அவற்றின் வகைகளில் ChannelPeople, ChannelGroup, ChannelContact, ChannelContactNumber, ChannelExternalNumber, ChannelService, மற்றும் ChannelRecorder ஆகியவை அடங்கும்.
தொடர்பு
செயலில் உள்ள தகவல் தொடர்பு அமர்வுகளைத் தொடங்கி நிர்வகிக்கவும் — வெளிச்செல்லும் அழைப்புகள், VCP, பதிவு செய்தல் மற்றும் உள்ளடக்க ஸ்ட்ரீமிங். வெளிச்செல்லும் அழைப்பிற்கான பதிலில் ஒரு CBBPMessage அடங்கியுள்ளது, அதன் மீது சாதனம் உடனடியாகச் செயல்படுகிறது.
ஆடியோ பிரிட்ஜ்
முழுமையான எழுத்துப்படிவங்கள், பங்கேற்பாளர் பட்டியல்கள் மற்றும் செயற்கை நுண்ணறிவால் உருவாக்கப்பட்ட சுருக்கங்கள் உள்ளிட்ட பதிவுசெய்யப்பட்ட இணைப்பு உரையாடல்களை அணுகவும். பல சுருக்க வார்ப்புருக்களையும் (கூட்டக் குறிப்புகள், வகுப்புக் குறிப்புகள், சுகாதாரப் பராமரிப்பு போன்றவை) மற்றும் சுருக்கங்களுக்கான TTS ஒலி உருவாக்கத்தையும் ஆதரிக்கிறது.
உரையாடல்கள்
ChatGPT, Gemini அல்லது நேட்டிவ் இன்ஜினைப் பயன்படுத்தி செயற்கை நுண்ணறிவால் இயங்கும் உரையாடல் அமர்வுகள். மருத்துவர், பயிற்றுநர், மெக்கானிக் போன்ற பல ஆளுமைகளையும், பக்கப்படுத்தப்பட்ட செய்தி வரலாற்றையும் ஆதரிக்கிறது.
உள்ளடக்கம்
சாதனங்களில் ஸ்ட்ரீமிங் ஆடியோ உள்ளடக்கத்தை உலாவவும் இயக்கவும். உள்ளடக்கம் ஒரு வகை மர அமைப்பில் ஒழுங்கமைக்கப்பட்டுள்ளது; பிரபலமான உள்ளடக்கத்தை நகரம், பிராந்தியம் அல்லது நாடு வாரியாக வடிகட்டலாம்.
இடங்கள்
புவியியல் ஆயங்களை ஒரு கட்டமைக்கப்பட்ட நகரம், பிராந்தியம் மற்றும் நாடு சார்ந்த பொருளாக மாற்றுகிறது. சூழலை உள்ளீடாகப் பெறும்போது சாதனங்களால் இது பயன்படுத்தப்படுகிறது.
புஷ் அறிவிப்புகள்
FCM புஷ் அறிவிப்புகளைப் பெற ஒரு மொபைல் செயலியைப் பதிவு செய்யவும். iOS, ஆண்ட்ராய்டு மற்றும் இணையச் செயலிகளை ஆதரிக்கிறது.
சேமிப்பு
மாதிரிப் பொருட்களில் சேமிக்கப்பட்டுள்ள கோப்புகளைப் பதிவிறக்கம் செய்து, படப் பின்னணி நீக்கத்தைச் செயல்படுத்தவும் (இது base64-குறியாக்கப்பட்ட முடிவைத் தரும்).
மொத்த செயல்பாடுகள்
ஒரே HTTP கோரிக்கையில் பல API செயல்பாடுகளைச் செயல்படுத்தவும். அனைத்து செயல்பாடுகளையும் ஒரே அணுநிலை பரிவர்த்தனையில் இணைக்க, single_transaction=true என்பதை அனுப்பவும் — இதில் ஏதேனும் ஒரு செயல்பாடு தோல்வியுற்றால், முழுத் தொகுப்பும் திரும்பப் பெறப்படும்.
தேதி மற்றும் நேரம்
தற்போதைய சேவையகத்தின் தேதி மற்றும் நேரத்தை GMT+0 அளவில் வழங்கும். இதற்கு அங்கீகாரம் தேவையில்லை. சாதனங்கள் தங்களின் உள்ளகக் கடிகாரத்தை ஒத்திசைக்க இதைப் பயன்படுத்துகின்றன.
காம் பேட்ஜ் அடிப்படை நெறிமுறை
CBBP என்பது கனெக்ஷன் பேட்ஜ்களுடன் நேரடியாக ஊடாடுவதற்கான ஒரு இலகுவான JSON கட்டளை நெறிமுறை ஆகும். இது சாதனத்தில் உள்ள ஒவ்வொரு வன்பொருள் மற்றும் மென்பொருள் செயல்பாட்டின் மீதும் உங்களுக்கு முழுமையான கட்டுப்பாட்டை அளிக்கிறது.
செய்தி வடிவம்
ஒவ்வொரு CBBP தொடர்பும், சாதனத்திற்கு அனுப்பப்படும் ஒரு கட்டளைச் செய்தியையும், சாதனத்தால் திருப்பி அனுப்பப்படும் ஒரு முடிவுச் செய்தியையும் கொண்டுள்ளது.
கோரிக்கை மற்றும் பதில் ஆகிய இரண்டிலும் உள்ள பொருள் புலம், கட்டளை சார்ந்த தரவுகளைக் கொண்டுள்ளது, மேலும் தேவைப்படாதபோது அதைத் தவிர்க்கலாம்.
{
"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
}
}போக்குவரத்து
உங்கள் ஒருங்கிணைப்புக் கட்டமைப்பைப் பொறுத்து, CBBP செய்திகளை மூன்று வெவ்வேறு போக்குவரத்து வழிகள் மூலம் ஒரு பேட்ஜுக்கு அனுப்ப முடியும்.
புளூடூத் (செயலி)
மொபைல் செயலியிலிருந்து BLE வழியாக நேரடியாக CBBP கட்டளைகளை அனுப்பலாம். இதற்கு, சாதனம் இணைக்கப்பட்டு, வரம்பிற்குள் இருக்க வேண்டும்.
மொபைல் SDKசர்வர் வழியாக வைஃபை அல்லது புளூடூத்
REST API வழியாக CBBP-ஐ ப்ராக்ஸி செய்யவும் — POST /devices//cbbp. பேட்ஜ் எவ்வாறு இணைக்கப்பட்டுள்ளது என்பதைப் பொறுத்து, சர்வர் தானாகவே WiFi அல்லது Bluetooth வழியாக சாதனத்திற்கு வழிநடத்துகிறது. இது பேக்கெண்ட் ஒருங்கிணைப்புகளுக்கு மிகவும் பொதுவானது.
REST APIஉள் அனுப்பீடு
சாதனத்தினுள் அல்லது செயல்முறைகளுக்கு இடையேயான CBBP அனுப்பீடு. உள்ளகத் துணை அமைப்புகளுக்கு இடையில் கட்டளைகளை வழிநடத்த, பேட்ஜ் ஃபார்ம்வேரால் இது பயன்படுத்தப்படுகிறது.
ஃபார்ம்வேர் மட்டும்சக்தி கட்டளைகள்
சாதனத்தின் ஆற்றல் நிலையைக் கட்டுப்படுத்துதல் — உறக்கம், விழிப்பு, மறுதொடக்கம் மற்றும் தொழிற்சாலை மீட்டமைப்பு.
வைஃபை கட்டளைகள்
கம்பியில்லா வலையமைப்புகளை உள்ளமைக்கவும், AP-களைத் தேடவும், இணைப்பு நிலையைச் சரிபார்க்கவும், மற்றும் சேமிக்கப்பட்ட நற்சான்றுகளை நிர்வகிக்கவும்.
புளூடூத் கட்டளைகள்
BLE விளம்பரம், இணைத்தல் மற்றும் பேட்ஜ்களுக்கு இடையேயான தகவல் தொடர்பு ஆகியவற்றைக் கட்டுப்படுத்தவும்.
அமைப்புகள் கட்டளைகள்
சாதன உள்ளமைவைப் படிக்கவும் எழுதவும் — காட்சிப் பெயர், நேர மண்டலம், மொழி மற்றும் அம்சக் குறியீடுகள்.
நிலைபொருள் கட்டளைகள்
OTA ஃபர்ம்வேர் புதுப்பிப்புகளைத் தொடங்கவும், புதுப்பிப்பு நிலையைச் சரிபார்க்கவும், மற்றும் சாதனத்தில் உள்ள தற்போதைய ஃபர்ம்வேர் பதிப்பைக் கண்டறியவும்.
சாதனக் கட்டளைகள்
சாதனத்தின் ஆயுட்காலம், அங்கீகாரம், உள்ளமைவு, பதிவேடு, நிலை மற்றும் வன்பொருள் கட்டுப்பாடு.
தொடர்பு கட்டளைகள்
அழைப்புகளைத் தொடங்குதல், செய்திகளை அனுப்புதல், செயலில் உள்ள தகவல் தொடர்பு அமர்வுகளை நிர்வகித்தல் மற்றும் பதிவைக் கட்டுப்படுத்துதல்.
ஆடியோ கட்டளைகள்
ஸ்பீக்கர் ஒலியளவு, மைக்ரோஃபோன் கெயின், ஆடியோ புரொஃபைல்கள் மற்றும் உரையை பேச்சாக மாற்றும் வசதி ஆகியவற்றைக் கட்டுப்படுத்தலாம்.
LED கட்டளைகள்
பேட்ஜ் இண்டிகேட்டர் விளக்கில் LED நிறம், பிரகாசம் மற்றும் அனிமேஷன் வடிவங்களை அமைக்கவும்.
உள் கட்டளைகள்
சூழல் வழங்கல், சேனல் வரலாறு, குரல் பதிவு மற்றும் ஆடியோ டிகோடிங் ஆகியவற்றிற்காகப் பயன்படுத்தப்படும் உள்ளக அனுப்பீட்டுக் கட்டளைகள்.
மொபைல் கட்டளைகள்
இணைக்கப்பட்ட மொபைல் செயலியுடன் பேட்ஜை ஒருங்கிணைப்பதற்கான கட்டளைகள் — புஷ் அறிவிப்புகள், செயலி நிலை ஒத்திசைவு மற்றும் டீப் லிங்கிங்.