- Hem
- API-dokumentation
API-dokumentation
Få programmatisk åtkomst till dina krypterade data med hjälp av vårt säkra REST API med token-baserad autentisering.
Kapitel
Komma igång
Generera en API-nyckel i dina kontoinställningar för att börja
För att använda Hexbon API måste du generera en API-nyckel från din Kontoinställningar → API-inställningar sida. API:et använder ett tvåstegs autentiseringsflöde för ökad säkerhet.
Autentiseringsflöde
Begär en Token
Använd din API-nyckel för att begära en tillfällig åtkomsttoken via POST /api/v1/auth
Token Giltighet
Token är giltig i 60 minuter. Efter utgången, begär en ny token.
Använd Token
Inkludera token i Authorization: Bearer <token> rubriken för dataoperationer.
Hastighetsbegränsning
API:et är begränsat till 10 förfrågningar per minut per användare. Att överskrida denna gräns kommer att resultera i ett 429 Too Many Requests svar.
Slutpunkter
Autentisera
https://hexbon.com/api/v1/auth
Generera en tillfällig åtkomsttoken med din API-nyckel.
Rubriker
| X-API-Key | Din API-nyckel (krävs) |
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
}
Läs
https://hexbon.com/api/v1/data
Hämta dina krypterade data. Returnerar den klientkrypterade nyttolasten (v1:...).
Rubriker
| Authorization | Bearer <token> (krävs) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Uppdatera
https://hexbon.com/api/v1/data
Spara dina krypterade data. Accepterar en klientkrypterad nyttolast (v1:...) i förfrågningskroppen.
Obs: Skrivåtkomst måste vara aktiverad i dina API-inställningar. Som standard är API-åtkomst skrivskyddad.
Rubriker
| Authorization | Bearer <token> (krävs) |
| Content-Type | application/json (krävs) |
Förfrågningskropp
| data | Klientkrypterad nyttolast som börjar med v1: (krävs) |
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."
}
Svarsformat
Alla API-svar returneras i JSON-format med ett booleskt fält success som anger resultatet av operationen.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Felkoder
| Kod | Beskrivning |
|---|---|
| 401 | Ogiltig eller saknad API-nyckel / token utgången |
| 403 | Skrivåtkomst inaktiverad (för POST /data) |
| 422 | Ogiltigt nyttolastformat eller lagringsgräns överskriden |
| 429 | Hastighetsgräns överskriden (10 förfrågningar/minut) |
| 500 | Internt serverfel |
Redo att börja?
Generera din API-nyckel och börja integrera med Hexbon idag.
Gå till API-inställningar