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