Επισκόπηση API & Διαχείριση Κλειδιών API
Το Rayo SMS HTTP REST API σάς επιτρέπει να ενσωματώσετε την αποστολή μεμονωμένων και μαζικών SMS, τον προγραμματισμό αποστολών και τον έλεγχο υπολοίπου απευθείας στο ERP, το CRM, το e-shop ή την custom εφαρμογή σας.
Βασικό URL (Base URL) & Ασφάλεια HTTPS
Ενότητα με τίτλο «Βασικό URL (Base URL) & Ασφάλεια HTTPS»Όλες οι κλήσεις προς το REST API πραγματοποιούνται αποκλειστικά μέσω κρυπτογραφημένης σύνδεσης HTTPS στο ακόλουθο Base URL:
- Base URL:
https://sms-api.rayo.gr/v1
Κάθε αίτημα (request) και απάντηση (response) με σώμα δεδομένων χρησιμοποιεί μορφή application/json; charset=utf-8.
Διαχείριση Κλειδιών API (Κλειδιά API)
Ενότητα με τίτλο «Διαχείριση Κλειδιών API (Κλειδιά API)»Για την αυθεντικοποίηση των κλήσεών σας απαιτείται ένα ενεργό Κλειδί API (API Key). Μπορείτε να διαχειριστείτε τα κλειδιά σας από το μενού Προχωρημένες Ενέργειες -> Ρυθμίσεις -> Κλειδιά API στο Περιβάλλον Εφαρμογής Rayo SMS.
- Όριο έως 25 Κλειδιά API: Κάθε λογαριασμός μπορεί να διατηρεί έως 25 Κλειδιά API ταυτόχρονα, ώστε να απομονώνετε διαφορετικές εφαρμογές, περιβάλλοντα (production, staging) ή εξωτερικούς συνεργάτες.
- Διαθέσιμες Ενέργειες:
Δημιουργία Κλειδιού API: Παράγει ένα νέο μοναδικό κλειδί API.Ενεργοποίηση/Απενεργοποίηση: Σας επιτρέπει να αναστείλετε προσωρινά ή να επαναφέρετε την πρόσβαση ενός κλειδιού χωρίς να το διαγράψετε.Διαγραφή: Καταργεί οριστικά το κλειδί API, ακυρώνοντας αμέσως κάθε μελλοντική κλήση που το χρησιμοποιεί.
Αυθεντικοποίηση (Authorization Header)
Ενότητα με τίτλο «Αυθεντικοποίηση (Authorization Header)»Κάθε κλήση προς το API πρέπει να περιλαμβάνει ένα ενεργό Κλειδί API στην κεφαλίδα HTTP Authorization μέσω HTTPS:
Authorization: Bearer ΤΟ_ΚΛΕΙΔΙ_ΣΑΣ_APIContent-Type: application/jsonΣύνοψη Βασικών Endpoints
Ενότητα με τίτλο «Σύνοψη Βασικών Endpoints»Παρακάτω συνοψίζονται τα κύρια endpoints του Rayo SMS API (σχετικά με το Base URL https://sms-api.rayo.gr/v1):
| Μέθοδος & Endpoint | Περιγραφή |
|---|---|
POST /v1/send_sms |
Αποστολή άμεσου ή χρονοπρογραμματισμένου SMS σε έναν ή περισσότερους παραλήπτες. |
GET /v1/balance_in_credits |
Ανάκτηση του τρέχοντος διαθέσιμου υπολοίπου μονάδων (credits) του λογαριασμού. |
GET /v1/check_status |
Έλεγχος διαθεσιμότητας της υπηρεσίας API και εγκυρότητας του Κλειδιού API σας. |
DELETE /v1/sms_request_schedules/:id |
Ακύρωση μιας προγραμματισμένης αποστολής SMS πριν την ώρα εκτέλεσής της. |
Δωρεάν Δοκιμές με Λειτουργία Προσομοίωσης (simulateSendFlag)
Ενότητα με τίτλο «Δωρεάν Δοκιμές με Λειτουργία Προσομοίωσης (simulateSendFlag)»Κατά την ανάπτυξη και τον έλεγχο της διασύνδεσής σας στο POST /v1/send_sms, μπορείτε να χρησιμοποιήσετε την παράμετρο simulateSendFlag (θέτοντάς την σε true):
- Το API επικυρώνει πλήρως το αίτημά σας (αυθεντικοποίηση, αναγνωριστικό αποστολέα, αριθμούς παραληπτών, μήκος μηνύματος, παραμέτρους χρονοπρογραμματισμού).
- Επιστρέφει ρεαλιστική απάντηση επιτυχίας ή σφάλματος χωρίς να αποσταλεί πραγματικό SMS στο δίκτυο κινητής τηλεφωνίας και χωρίς καμία χρέωση μονάδων.