Πιστοποίηση API
Όλα τα αιτήματα API προς το SilentShield απαιτούν πιστοποίηση. Υπάρχουν δύο μέθοδοι πιστοποίησης ανάλογα με το endpoint.
Πιστοποίηση με κλειδί API
Τα περισσότερα endpoints χρησιμοποιούν πιστοποίηση με κλειδί API μέσω της κεφαλίδας X-Api-Key. Το κλειδί API σας είναι διαθέσιμο στον πίνακα ελέγχου στην ενότητα Κλειδιά API.
X-Api-Key: your-api-key-hereΧρησιμοποιήστε αυτή τη μέθοδο για: endpoints widget, επαλήθευση nonce και δημόσιες κλήσεις API.
Πιστοποίηση JWT
Τα endpoints πίνακα ελέγχου και διαχείρισης χρησιμοποιούν πιστοποίηση JWT (JSON Web Token). Αποκτήστε ένα token μέσω σύνδεσης στο endpoint πιστοποίησης.
POST /api/v1/auth/loginRequest Body:
{"email": "[email protected]", "password": "your-password"}Response:
{"token": "eyJhbGciOiJIUzI1NiIs...", "expiresIn": 86400}Authorization: Bearer eyJhbGciOiJIUzI1NiIs...Χρησιμοποιήστε αυτή τη μέθοδο για: endpoints διαχείρισης, ερωτήματα αναλύσεων, διαχείριση ομάδας και ρυθμίσεις λογαριασμού.
Σφάλματα πιστοποίησης
| Status | Error | Solution |
|---|---|---|
401 | missing credentials | Προσθέστε την κεφαλίδα X-Api-Key ή Authorization. |
401 | invalid_api_key | Ελέγξτε ότι το κλειδί API σας είναι σωστό και ενεργό. |
401 | token_expired | Το JWT σας έχει λήξει. Ζητήστε νέο token μέσω /api/v1/auth/login. |
403 | insufficient_permissions | Ο ρόλος σας δεν έχει πρόσβαση σε αυτό το endpoint. |
Όρια ρυθμού
Τα αιτήματα API περιορίζονται ανά διεύθυνση IP. Το προεπιλεγμένο όριο είναι 60 αιτήματα ανά λεπτό για endpoints διαχείρισης και 1000 αιτήματα ανά λεπτό για endpoints widget. Κεφαλίδες ορίου ρυθμού περιλαμβάνονται σε κάθε απάντηση.
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-ResetRetry-After (μόνο σε 429)