Τекμηρίωση API
Αποκτήστε προγραμματιστική πρόσβαση στα κρυπτογραφημένα δεδομένα σας χρησιμοποιώντας το ασφαλές REST API μας με έλεγχο ταυτότητας βάσει διακριτικού.
Κεφάλαια
Ξεκινώντας
Δημιουργήστε ένα κλειδί API στις ρυθμίσεις του λογαριασμού σας για να ξεκινήσετε
Για να χρησιμοποιήσετε το API Hexbon, πρέπει να δημιουργήσετε ένα κλειδί API από τη σελίδα Ρυθμίσεις Λογαριασμού → Ρυθμίσεις API. Το API χρησιμοποιεί μια ροή ελέγχου ταυτότητας δύο βημάτων για βελτιωμένη ασφάλεια.
Ροή Ελέγχου Ταυτότητας
Αίτημα Διακριτικού
Χρησιμοποιήστε το κλειδί API σας για να ζητήσετε ένα προσωρινό διακριτικό πρόσβασης μέσω POST /api/v1/auth
Εγκυρότητα Διακριτικού
Το διακριτικό είναι έγκυρο για 60 λεπτά. Μετά τη λήξη, ζητήστε νέο διακριτικό.
Χρήση Διακριτικού
Συμπεριλάβετε το διακριτικό στην κεφαλίδα Authorization: Bearer <token> για λειτουργίες δεδομένων.
Όριο Ρυθμού
Το API περιορίζεται σε 10 αιτήματα ανά λεπτό ανά χρήστη. Η υπέρβαση αυτού του ορίου θα οδηγήσει σε απόκριση 429 Too Many Requests.
Τελικά Σημεία
Έλεγχος Ταυτότητας
https://hexbon.com/api/v1/auth
Δημιουργήστε ένα προσωρινό διακριτικό πρόσβασης χρησιμοποιώντας το κλειδί API σας.
Κεφαλίδες
| X-API-Key | Το κλειδί API σας (απαιτείται) |
curl -X POST "https://hexbon.com/api/v1/auth" \ -H "X-API-Key: your_api_key_here"
{
"success": true,
"bearer_token": "abc123def456...",
"expires_at": "2025-11-27T15:30:00Z",
"expires_in": 3600
}
Ανάγνωση
https://hexbon.com/api/v1/data
Ανακτήστε τα κρυπτογραφημένα δεδομένα σας. Επιστρέφει το κρυπτογραφημένο από τον πελάτη ωφέλιμο φορτίο (v1:...).
Κεφαλίδες
| Authorization | Bearer <token> (απαιτείται) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Ενημέρωση
https://hexbon.com/api/v1/data
Αποθηκεύστε τα κρυπτογραφημένα δεδομένα σας. Δέχεται ένα κρυπτογραφημένο από τον πελάτη ωφέλιμο φορτίο (v1:...) στο σώμα του αιτήματος.
Σημείωση: Η πρόσβαση εγγραφής πρέπει να είναι ενεργοποιημένη στις Ρυθμίσεις API σας. Από προεπιλογή, η πρόσβαση API είναι μόνο για ανάγνωση.
Κεφαλίδες
| Authorization | Bearer <token> (απαιτείται) |
| Content-Type | application/json (απαιτείται) |
Σώμα Αιτήματος
| data | Κρυπτογραφημένο από τον πελάτη ωφέλιμο φορτίο που ξεκινά με v1: (απαιτείται) |
curl -X POST "https://hexbon.com/api/v1/data" \
-H "Authorization: Bearer your_token_here" \
-H "Content-Type: application/json" \
-d '{"data": "v2:your_encrypted_payload"}'
{
"success": true,
"message": "Encrypted data saved successfully."
}
Μορφή Απόκρισης
Όλες οι αποκρίσεις API επιστρέφονται σε μορφή JSON με ένα πεδίο boolean success που υποδεικνύει το αποτέλεσμα της λειτουργίας.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Κωδικοί Σφάλματος
| Κωδικός | Περιγραφή |
|---|---|
| 401 | Μη έγκυρο ή λείπει κλειδί API / λήξη διακριτικού |
| 403 | Πρόσβαση εγγραφής απενεργοποιημένη (για POST /data) |
| 422 | Μη έγκυρη μορφή ωφέλιμου φορτίου ή υπέρβαση ορίου αποθήκευσης |
| 429 | Υπέρβαση ορίου ρυθμού (10 αιτήματα/λεπτό) |
| 500 | Εσωτερικό σφάλμα διακομιστή |
Έτοιμοι να ξεκινήσετε;
Δημιουργήστε το κλειδί API σας και ξεκινήστε την ενσωμάτωση με το Hexbon σήμερα.
Μετάβαση στις Ρυθμίσεις API