Dokumentace API
Získejte programový přístup k vašim šifrovaným datům pomocí našeho zabezpečeného REST API s autentizací založenou na tokenech.
Kapitoly
Začínáme
Vygenerujte si API klíč v nastavení účtu, abyste mohli začít
Pro použití API Hexbon musíte vygenerovat API klíč na stránce Nastavení Účtu → Nastavení API. API používá dvoufázový proces autentizace pro zvýšenou bezpečnost.
Proces Autentizace
Požádat o Token
Použijte svůj API klíč k vyžádání dočasného přístupového tokenu přes POST /api/v1/auth
Platnost Tokenu
Token je platný po dobu 60 minut. Po vypršení požádejte o nový token.
Použít Token
Zahrňte token do hlavičky Authorization: Bearer <token> pro operace s daty.
Omezení Rychlosti
API je omezeno na 10 požadavků za minutu na uživatele. Překročení tohoto limitu bude mít za následek odpověď 429 Too Many Requests.
Koncové Body
Autentizovat
https://hexbon.com/api/v1/auth
Vygenerujte dočasný přístupový token pomocí vašeho API klíče.
Hlavičky
| X-API-Key | Váš API klíč (povinné) |
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
}
Číst
https://hexbon.com/api/v1/data
Získejte svá šifrovaná data. Vrací klientem šifrovaný payload (v1:...).
Hlavičky
| Authorization | Bearer <token> (povinné) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Aktualizovat
https://hexbon.com/api/v1/data
Uložte svá šifrovaná data. Přijímá klientem šifrovaný payload (v1:...) v těle požadavku.
Poznámka: Přístup pro zápis musí být povolen ve vašem Nastavení API. Ve výchozím nastavení je přístup k API pouze pro čtení.
Hlavičky
| Authorization | Bearer <token> (povinné) |
| Content-Type | application/json (povinné) |
Tělo Požadavku
| data | Klientem šifrovaný payload začínající na v1: (povinné) |
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."
}
Formát Odpovědi
Všechny odpovědi API jsou vráceny ve formátu JSON s booleovským polem success indikujícím výsledek operace.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Chybové Kódy
| Kód | Popis |
|---|---|
| 401 | Neplatný nebo chybějící API klíč / token vypršel |
| 403 | Přístup pro zápis zakázán (pro POST /data) |
| 422 | Neplatný formát payloadu nebo překročen limit úložiště |
| 429 | Překročen limit rychlosti (10 požadavků/minutu) |
| 500 | Interní chyba serveru |
Připraveni začít?
Vygenerujte si API klíč a začněte integrovat s Hexbon ještě dnes.
Přejít na Nastavení API