Πιστοποίηση
Το API σύνδεσης χρησιμοποιεί έλεγχο ταυτότητας διακριτικού φορέα. Όλα τα αιτήματα πρέπει να περιλαμβάνουν ένα έγκυρο διακριτικό πρόσβασης JWT στην κεφαλίδα Εξουσιοδότησης.
Αποκτήστε ένα διακριτικό
ΑΠΟΣΤΟΛΗΣΤΕ τα διαπιστευτήριά σας στο τελικό σημείο ελέγχου ταυτότητας. Θα λάβετε ένα βραχύβιο 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 εξαρτάται από την ανάπτυξή σας.
Για αναπτύξεις που φιλοξενούνται στο cloud, χρησιμοποιήστε το περιφερειακό τελικό σημείο που έχει αντιστοιχιστεί στον οργανισμό σας. Για αναπτύξεις διακομιστών εσωτερικής εγκατάστασης, χρησιμοποιήστε το όνομα κεντρικού υπολογιστή του διακομιστή σας.
| Περιβάλλο | Βασική διεύθυνση URL |
|---|---|
| Cloud (ΗΠΑ) | https://beta.connection.app/api/v1 |
| Εσωτερική χρήση | https://<your-server>/api/v1 |
Όλα τα σώματα αιτημάτων και απαντήσεων χρησιμοποιούν application/json. Συμπεριλάβετε τον τύπο περιεχομένου: 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
Το Connection Server REST API παρέχει πλήρη προγραμματική πρόσβαση στο στόλο συσκευών σας, στην υποδομή επικοινωνιών και στα αναλυτικά στοιχεία. Ακολουθεί τις συμβάσεις RESTful με σώματα αιτημάτων/απαντήσεων JSON.
Πιστοποίηση
Έλεγχος ταυτότητας βάσει διακριτικού. Η σύνδεση επιστρέφει ένα διακριτικό που πρέπει να σταλεί ως Εξουσιοδότηση: Διακριτικό<token> σε όλα τα επόμενα αιτήματα.
Χρήστες
Δημιουργήστε και διαχειριστείτε λογαριασμούς χρηστών. Το τελικό σημείο GET /users/user επιστρέφει τον τρέχοντα πιστοποιημένο χρήστη.
Συσκευές
Καταγράψτε και ελέγξτε συσκευές, διαχειριστείτε συσχετίσεις χρήστη-συσκευής, διαβάστε και γράψτε ρυθμίσεις και κατάσταση ανά συσκευή, χειριστείτε εικόνες υλικολογισμικού και χώρου αποθήκευσης και λάβετε αρχεία καταγραφής και αναφορές σφαλμάτων.
Πληρεξούσιος CBBP
Στείλτε οποιαδήποτε εντολή CBBP σε μια συσκευή μέσω του διακομιστή. Ο διακομιστής μεταδίδει την εντολή μέσω της σύνδεσης WiFi της συσκευής και επιστρέφει την απόκριση της συσκευής. Η εξερχόμενη απόκριση make ενσωματώνει επίσης ένα μήνυμα 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, εγγραφή και ροή περιεχομένου. Η απόκριση εξερχόμενης κλήσης περιλαμβάνει ένα μήνυμα CBBP στο οποίο η συσκευή ενεργεί αμέσως.
Γέφυρα ήχου
Αποκτήστε πρόσβαση σε ηχογραφημένες συνομιλίες γέφυρας, συμπεριλαμβανομένων πλήρων μεταγραφών, λιστών συμμετεχόντων και περιλήψεων που δημιουργούνται από τεχνητή νοημοσύνη. Υποστηρίζει πολλαπλά πρότυπα περιλήψεων (σημειώσεις συσκέψεων, σημειώσεις μαθήματος, υγειονομική περίθαλψη κ.λπ.) και δημιουργία ήχου TTS για περιλήψεις.
Συζητήσεις
Συνεδρίες συνομιλίας με τεχνητή νοημοσύνη χρησιμοποιώντας ChatGPT, Gemini ή την εγγενή μηχανή αναζήτησης. Υποστηρίζει πολλαπλές περσόνες (Γιατρός, Καθηγητής, Μηχανικός κ.λπ.) και σελιδοποιημένο ιστορικό μηνυμάτων.
Περιεχόμενο
Περιηγηθείτε και αναπαράγετε περιεχόμενο ήχου σε ροή σε συσκευές. Το περιεχόμενο είναι οργανωμένο σε δέντρο κατηγοριών. Το δημοφιλές περιεχόμενο μπορεί να φιλτραριστεί ανά πόλη, περιοχή ή χώρα.
Τοποθεσίες
Ανάλυση γεωγραφικών συντεταγμένων σε ένα δομημένο αντικείμενο πόλης, περιοχής και χώρας. Χρησιμοποιείται από συσκευές κατά την εισαγωγή περιεχομένου.
Ειδοποιήσεις push
Εγγραφείτε μια εφαρμογή για κινητά για να λαμβάνετε ειδοποιήσεις push FCM. Υποστηρίζει στόχους iOS, Android και web.
Αποθήκευση
Λήψη αρχείων που είναι αποθηκευμένα σε αντικείμενα μοντέλου και εκτέλεση αφαίρεσης φόντου εικόνας (επιστρέφει αποτέλεσμα με κωδικοποίηση base64).
Μαζικές Λειτουργίες
Εκτέλεση πολλαπλών λειτουργιών API σε ένα μόνο αίτημα HTTP. Μεταβιβάστε την εντολή single_transaction=true για να τυλίξετε όλες τις λειτουργίες σε μία ατομική συναλλαγή — μια αποτυχία σε οποιοδήποτε στοιχείο αναιρεί ολόκληρη την παρτίδα.
Ημερομηνία & Ώρα
Επιστρέφει την τρέχουσα ημερομηνία και ώρα διακομιστή σε GMT+0. Δεν απαιτεί έλεγχο ταυτότητας. Χρησιμοποιείται από συσκευές για τον συγχρονισμό του εσωτερικού τους ρολογιού.
Βασικό Πρωτόκολλο Σήματος Com
Το CBBP είναι ένα ελαφρύ πρωτόκολλο εντολών JSON για άμεση αλληλεπίδραση με τα Connection badges. Σας δίνει πλήρη έλεγχο σε κάθε λειτουργία υλικού και λογισμικού της συσκευής.
Μορφή μηνύματος
Κάθε αλληλεπίδραση 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 μπορούν να παραδοθούν σε ένα badge μέσω τριών διαφορετικών μεταφορών, ανάλογα με την αρχιτεκτονική ενσωμάτωσής σας.
Bluetooth (Εφαρμογή)
Στείλτε εντολές CBBP απευθείας από μια εφαρμογή για κινητά μέσω BLE. Απαιτεί η συσκευή να είναι συζευγμένη και εντός εμβέλειας.
SDK για κινητάWiFi ή Bluetooth μέσω διακομιστή
Διακομιστής μεσολάβησης CBBP μέσω του REST API — POST /devices//cbbp. Ο διακομιστής δρομολογεί αυτόματα τη συσκευή μέσω WiFi ή Bluetooth, ανάλογα με τον τρόπο σύνδεσης του badge. Πιο συνηθισμένο για ενσωματώσεις backend.
API RESTΕσωτερική Αποστολή
Αποστολή CBBP εντός συσκευής ή μεταξύ διεργασιών. Χρησιμοποιείται από το υλικολογισμικό του badge για τη δρομολόγηση εντολών μεταξύ εσωτερικών υποσυστημάτων.
Μόνο υλικολογισμικόΕντολές ισχύος
Έλεγχος κατάστασης ενέργειας της συσκευής — αναστολή λειτουργίας, αφύπνιση, επανεκκίνηση και επαναφορά εργοστασιακών ρυθμίσεων.
Εντολές WiFi
Διαμορφώστε ασύρματα δίκτυα, σαρώστε για σημεία πρόσβασης, ελέγξτε την κατάσταση σύνδεσης και διαχειριστείτε τα αποθηκευμένα διαπιστευτήρια.
Εντολές Bluetooth
Ελέγξτε τη διαφήμιση BLE, τη σύζευξη και την επικοινωνία μεταξύ σημάτων.
Εντολές ρυθμίσεων
Ανάγνωση και εγγραφή διαμόρφωσης συσκευής — εμφανιζόμενο όνομα, ζώνη ώρας, γλώσσα και σημαίες λειτουργιών.
Εντολές υλικολογισμικού
Ενεργοποιήστε ενημερώσεις υλικολογισμικού OTA, ελέγξτε την κατάσταση ενημέρωσης και υποβάλετε ερώτημα για την τρέχουσα έκδοση υλικολογισμικού στη συσκευή.
Εντολές συσκευής
Κύκλος ζωής συσκευής, έλεγχος ταυτότητας, διαμόρφωση, καταγραφή, κατάσταση και έλεγχος υλικού.
Εντολές επικοινωνίας
Ξεκινήστε κλήσεις, στείλτε μηνύματα, διαχειριστείτε ενεργές συνεδρίες επικοινωνίας και ελέγξτε την εγγραφή.
Εντολές ήχου
Ελέγξτε την ένταση του ηχείου, την ενίσχυση του μικροφώνου, τα προφίλ ήχου και την αναπαραγωγή κειμένου σε ομιλία.
Εντολές LED
Ρυθμίστε το χρώμα, τη φωτεινότητα και τα μοτίβα κίνησης των LED στην ενδεικτική λυχνία σήματος.
Εσωτερικές εντολές
Εσωτερικές εντολές αποστολής που χρησιμοποιούνται για την παράδοση περιεχομένου, το ιστορικό καναλιών, την φωνοποίηση και την αποκωδικοποίηση ήχου.
Εντολές για κινητά
Εντολές για τον συντονισμό του σήματος με μια συζευγμένη εφαρμογή για κινητά — ειδοποιήσεις push, συγχρονισμός κατάστασης εφαρμογής και σύνδεσμοι σε βάθος.