API Dokumentáció
Férjen hozzá programozottan titkosított adataihoz biztonságos REST API-nk segítségével, token alapú hitelesítéssel.
Fejezetek
Kezdő lépések
A kezdéshez generáljon egy API kulcsot a fiókbeállításaiban
A Hexbon API használatához generálnia kell egy API kulcsot a Fiókbeállítások → API Beállítások oldalán. Az API kétlépcsős hitelesítési folyamatot használ a fokozott biztonság érdekében.
Hitelesítési Folyamat
Token Kérése
Használja API kulcsát ideiglenes hozzáférési token kéréséhez a POST /api/v1/auth címen
Token Érvényessége
A token 60 percig érvényes. Lejárat után kérjen új tokent.
Token Használata
Adja meg a tokent a Authorization: Bearer <token> fejlécben az adatműveletekhez.
Sebességkorlátozás
Az API felhasználónként percenként 10 kérésre korlátozott. A korlát túllépése 429 Too Many Requests választ eredményez.
Végpontok
Hitelesítés
https://hexbon.com/api/v1/auth
Generáljon ideiglenes hozzáférési tokent API kulcsával.
Fejlécek
| X-API-Key | Az Ön API kulcsa (kötelező) |
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
}
Olvasás
https://hexbon.com/api/v1/data
Kérje le titkosított adatait. A kliens által titkosított adattartalmat (v1:...) adja vissza.
Fejlécek
| Authorization | Bearer <token> (kötelező) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Frissítés
https://hexbon.com/api/v1/data
Mentse el titkosított adatait. Kliens által titkosított adattartalmat (v1:...) fogad a kérés törzsében.
Megjegyzés: Az írási hozzáférést engedélyezni kell a API Beállítások oldalon. Alapértelmezés szerint az API hozzáférés csak olvasható.
Fejlécek
| Authorization | Bearer <token> (kötelező) |
| Content-Type | application/json (kötelező) |
Kérés Törzse
| data | Kliens által titkosított adattartalom v1: kezdettel (kötelező) |
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."
}
Válasz Formátum
Minden API válasz JSON formátumban érkezik, egy success logikai mezővel, amely a művelet eredményét jelzi.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Hibakódok
| Kód | Leírás |
|---|---|
| 401 | Érvénytelen vagy hiányzó API kulcs / lejárt token |
| 403 | Írási hozzáférés letiltva (POST /data esetén) |
| 422 | Érvénytelen adattartalom formátum vagy tárhelykorlát túllépve |
| 429 | Sebességkorlát túllépve (10 kérés/perc) |
| 500 | Belső szerverhiba |
Készen áll a kezdésre?
Generálja le API kulcsát és kezdje meg az integrációt a Hexbonnal még ma.
Ugrás az API Beállításokhoz