SMSBAT ChatHub API
Το ChatHub REST API διαχειρίζεται επαγγελματικές συνομιλίες Viber, συνομιλίες πελατών και ροές εργασίας αυτοματισμού υποστήριξης πελατών.
Βασική διεύθυνση URL
Τεκμηρίωση Swagger
Η διαδραστική τεκμηρίωση API είναι διαθέσιμη στη διεύθυνση:
Έλεγχος ταυτότητας
Το ChatHub χρησιμοποιεί ένα σύστημα ελέγχου ταυτότητας που βασίζεται σε διακριτικά Bearer με μάρκες JWT. Τα διακριτικά μπορούν να περάσουν με δύο τρόπους:
Μέθοδος 1: Κεφαλίδα εξουσιοδότησης
curl -X GET https://chatapi.smsbat.com/api/company/organization \
-H "Authorization: Bearer your-jwt-token"
Μέθοδος 2: X-Authorization-Key Header
curl -X GET https://chatapi.smsbat.com/api/company/organization \
-H "X-Authorization-Key: your-jwt-token"
Ροή ελέγχου ταυτότητας
Το ChatHub χρησιμοποιεί ένα σύστημα διακριτικών δύο επιπέδων:
- Company Token - Token πρόσβασης σε επίπεδο οργανισμού
- Operator Token - Μεμονωμένο διακριτικό πρόσβασης χειριστή
Ροή εργασιών
graph LR
A[Get Company Token] --> B[List Organizations]
B --> C[List/Add Operators]
C --> D[Get Operator Token]
D --> E[Integrate Widget]
Κύρια τελικά σημεία
| Μέθοδος | Τελικό σημείο | Περιγραφή |
|---|---|---|
| ΑΝΑΡΤΗΣΗ | /api/company/get-token |
Λάβετε διακριτικό εξουσιοδότησης εταιρείας |
| ΠΑΡΕ | «/api/εταιρεία/οργανισμός» | Ανάκτηση λίστας οργανισμών |
| ΠΑΡΕ | /api/operator |
Κατάλογος χειριστών ανά οργανισμό |
| ΑΝΑΡΤΗΣΗ | /api/operator/synchronize |
Προσθήκη νέων χειριστών |
| ΑΝΑΡΤΗΣΗ | «/api/operator/status» | Αλλαγή κατάστασης χειριστή |
| ΑΝΑΡΤΗΣΗ | /api/operator/get-token |
Δημιουργία κουπονιών χειριστή (μέγιστη λήξη 24 ωρών) |
| ΑΝΑΡΤΗΣΗ | /api/operator/validate-token |
Επαλήθευση εγκυρότητας διακριτικού |
Βασικά χαρακτηριστικά
Διαχείριση διακριτικών της εταιρείας
Αποκτήστε και διαχειριστείτε διακριτικά σε επίπεδο οργανισμού για πρόσβαση στο API.
Διοίκηση Οργανισμού
- Καταγράψτε όλους τους οργανισμούς
- Ανάκτηση στοιχείων οργάνωσης
- Διαχειριστείτε τις ρυθμίσεις του οργανισμού
Διαχείριση χειριστή
- Κατάλογος χειριστών ανά οργανισμό
- Προσθήκη νέων τελεστών
- Αλλαγή κατάστασης χειριστή (Ενεργός/Ανενεργός/Διαγραμμένος)
- Δημιουργήστε διακριτικά ειδικά για χειριστή (μέγιστο 24 ώρες)
- Επικύρωση διακριτικών χειριστή
Ενσωμάτωση γραφικών στοιχείων
Ενσωματώστε το γραφικό στοιχείο ChatHub σε εφαρμογές web για υποστήριξη πελατών σε πραγματικό χρόνο.
Γρήγορη εκκίνηση
- Έλεγχος ταυτότητας - Λάβετε τα διακριτικά της εταιρείας και του χειριστή σας
- Οργανισμοί - Διαχείριση οργανισμών
- Χειριστές - Προσθήκη και διαχείριση τελεστών
- Ενσωμάτωση γραφικών στοιχείων - Ενσωμάτωση γραφικού στοιχείου συνομιλίας
Μορφή αιτήματος
Όλα τα αιτήματα χρησιμοποιούν μορφή JSON:
Μορφή απόκρισης
Επιστροφή επιτυχών απαντήσεων:
Χειρισμός σφαλμάτων
Κωδικοί κατάστασης HTTP:
200 OK- Το αίτημα επιτυχής400 Bad Request- Μη έγκυρη μορφή αιτήματος401 Μη εξουσιοδοτημένο- Ο έλεγχος ταυτότητας απέτυχε403 Απαγορευμένο- Ανεπαρκή δικαιώματα404 Δεν βρέθηκε- Ο πόρος δεν βρέθηκε500 Εσωτερικό Σφάλμα διακομιστή- Σφάλμα διακομιστή
Λήξη διακριτικού
Τα token έχουν χρόνο λήξης. Όταν λήξει ένα διακριτικό:
- Το API θα επιστρέψει το "401 Unauthorized".
- Ζητήστε ένα νέο διακριτικό χρησιμοποιώντας το τελικό σημείο ελέγχου ταυτότητας
- Ενημερώστε την αίτησή σας με το νέο διακριτικό
Επόμενα βήματα
- Έλεγχος ταυτότητας - Μάθετε πώς να κάνετε έλεγχο ταυτότητας
- Οργανισμοί - Διαχείριση οργανισμών
- Χειριστές - Εργαστείτε με χειριστές
- Ενσωμάτωση γραφικών στοιχείων - Ενσωματώστε το γραφικό στοιχείο συνομιλίας