Dokumentacja API
Uzyskaj programowy dostęp do zaszyfrowanych danych za pomocą naszego bezpiecznego interfejsu REST API z uwierzytelnianiem opartym na tokenach.
Rozdziały
Wprowadzenie
Wygeneruj klucz API w ustawieniach konta, aby rozpocząć
Aby korzystać z API Hexbon, musisz wygenerować klucz API na stronie Ustawienia Konta → Ustawienia API. API wykorzystuje dwuetapowy proces uwierzytelniania dla zwiększenia bezpieczeństwa.
Proces Uwierzytelniania
Zażądaj Tokena
Użyj swojego klucza API, aby zażądać tymczasowego tokena dostępu przez POST /api/v1/auth
Ważność Tokena
Token jest ważny przez 60 minut. Po wygaśnięciu zażądaj nowego tokena.
Użyj Tokena
Dołącz token w nagłówku Authorization: Bearer <token> dla operacji na danych.
Ograniczenie Prędkości
API jest ograniczone do 10 żądań na minutę na użytkownika. Przekroczenie tego limitu spowoduje odpowiedź 429 Too Many Requests.
Punkty Końcowe
Uwierzytelnij
https://hexbon.com/api/v1/auth
Wygeneruj tymczasowy token dostępu za pomocą klucza API.
Nagłówki
| X-API-Key | Twój klucz API (wymagane) |
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
}
Odczyt
https://hexbon.com/api/v1/data
Pobierz swoje zaszyfrowane dane. Zwraca zaszyfrowany przez klienta ładunek (v1:...).
Nagłówki
| Authorization | Bearer <token> (wymagane) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Aktualizacja
https://hexbon.com/api/v1/data
Zapisz swoje zaszyfrowane dane. Akceptuje zaszyfrowany przez klienta ładunek (v1:...) w ciele żądania.
Uwaga: Dostęp do zapisu musi być włączony w twoich Ustawienia API. Domyślnie dostęp do API jest tylko do odczytu.
Nagłówki
| Authorization | Bearer <token> (wymagane) |
| Content-Type | application/json (wymagane) |
Ciało Żądania
| data | Zaszyfrowany przez klienta ładunek zaczynający się od v1: (wymagane) |
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."
}
Format Odpowiedzi
Wszystkie odpowiedzi API są zwracane w formacie JSON z polem logicznym success wskazującym wynik operacji.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Kody Błędów
| Kod | Opis |
|---|---|
| 401 | Nieprawidłowy lub brakujący klucz API / token wygasł |
| 403 | Dostęp do zapisu wyłączony (dla POST /data) |
| 422 | Nieprawidłowy format ładunku lub przekroczono limit pamięci |
| 429 | Przekroczono limit prędkości (10 żądań/minutę) |
| 500 | Wewnętrzny błąd serwera |
Gotowy do Startu?
Wygeneruj swój klucz API i zacznij integrację z Hexbon już dziś.
Przejdź do Ustawień API