API Dokumentatsioon
Pääse oma krüpteeritud andmetele ligi programmiliselt, kasutades meie turvalist REST API-t koos märgipõhise autentimisega.
Peatükid
Alustamine
Alustamiseks genereerige oma konto seadetes API võti
Hexbon API kasutamiseks peate genereerima API võtme oma Konto Seaded → API Seaded lehelt. API kasutab täiustatud turvalisuse tagamiseks kaheastmelist autentimisvoogu.
Autentimisvoog
Küsi Märki
Kasutage oma API võtit ajutise juurdepääsumärgi küsimiseks läbi POST /api/v1/auth
Märgi Kehtivus
Märk kehtib 60 minutit. Pärast aegumist küsige uus märk.
Kasuta Märki
Lisage märk Authorization: Bearer <token> päisesse andmeoperatsioonide jaoks.
Kiirusepiirang
API on piiratud 10 päringuga minutis kasutaja kohta. Selle limiidi ületamine toob kaasa 429 Too Many Requests vastuse.
Lõpp-punktid
Autentimine
https://hexbon.com/api/v1/auth
Genereerige ajutine juurdepääsumärk, kasutades oma API võtit.
Päised
| X-API-Key | Teie API võti (nõutav) |
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
}
Lugemine
https://hexbon.com/api/v1/data
Laadige alla oma krüpteeritud andmed. Tagastab kliendi poolt krüpteeritud kasuliku koormuse (v1:...).
Päised
| Authorization | Bearer <token> (nõutav) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Uuendamine
https://hexbon.com/api/v1/data
Salvestage oma krüpteeritud andmed. Aktsepteerib kliendi poolt krüpteeritud kasulikku koormust (v1:...) päringu kehas.
Märkus: Kirjutamisõigus peab olema lubatud teie API Seaded. Vaikimisi on API juurdepääs ainult lugemiseks.
Päised
| Authorization | Bearer <token> (nõutav) |
| Content-Type | application/json (nõutav) |
Päringu Keha
| data | Kliendi poolt krüpteeritud kasulik koormus, mis algab v1: (nõutav) |
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."
}
Vastuse Formaat
Kõik API vastused tagastatakse JSON formaadis koos tõeväärtusväljaga success, mis näitab operatsiooni tulemust.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Veakoodid
| Kood | Kirjeldus |
|---|---|
| 401 | Vigane või puuduv API võti / märk aegunud |
| 403 | Kirjutamisõigus keelatud (POST /data jaoks) |
| 422 | Vigane kasuliku koormuse formaat või salvestuslimiit ületatud |
| 429 | Kiirusepiirang ületatud (10 päringut/minutis) |
| 500 | Sisemine serveri viga |
Valmis alustama?
Genereerige oma API võti ja alustage Hexboniga integreerimist juba täna.
Mine API Seadetesse