API Документация
Достъпвайте програмно вашите криптирани данни, използвайки нашето сигурно REST API с токен-базирана автентикация.
Глави
Първи стъпки
Генерирайте API ключ в настройките на акаунта си, за да започнете
За да използвате Hexbon API, трябва да генерирате 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 с булево поле success, показващо резултата от операцията.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Кодове за Грешка
| Код | Описание |
|---|---|
| 401 | Невалиден или липсващ API ключ / изтекъл токен |
| 403 | Достъпът за запис е деактивиран (за POST /data) |
| 422 | Невалиден формат на полезния товар или надвишен лимит за съхранение |
| 429 | Надвишен лимит на скоростта (10 заявки/минута) |
| 500 | Вътрешна грешка на сървъра |
Готови ли сте да започнете?
Генерирайте своя API ключ и започнете интеграцията с Hexbon днес.
Към API Настройки