Dokumentasyon ng API
I-access ang iyong naka-encrypt na data sa pamamagitan ng program gamit ang aming secure na REST API na may token-based na pagpapatotoo.
Mga Kabanata
Pagsisimula
Bumuo ng API key sa iyong mga setting ng account upang makapagsimula
Upang magamit ang Hexbon API, kailangan mong bumuo ng API key mula sa iyong pahina ng Mga Setting ng Account → Mga Setting ng API. Gumagamit ang API ng dalawang-hakbang na daloy ng pagpapatotoo para sa pinahusay na seguridad.
Daloy ng Pagpapatotoo
Humiling ng Token
Gamitin ang iyong API key upang humiling ng pansamantalang access token sa pamamagitan ng POST /api/v1/auth
Bisa ng Token
Ang token ay may bisa sa loob ng 60 minuto. Pagkatapos mag-expire, humiling ng bagong token.
Gamitin ang Token
Isama ang token sa Authorization: Bearer <token> header para sa mga operasyon ng data.
Paglilimita sa Rate
Ang API ay limitado sa 10 kahilingan bawat minuto bawat user. Ang paglampas sa limitasyong ito ay magreresulta sa tugon na 429 Too Many Requests.
Mga Endpoint
Magpatotoo
https://hexbon.com/api/v1/auth
Bumuo ng pansamantalang access token gamit ang iyong API key.
Mga Header
| X-API-Key | Ang iyong API key (kinakailangan) |
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
}
Basahin
https://hexbon.com/api/v1/data
Kunin ang iyong naka-encrypt na data. Nagbabalik ng client-encrypted payload (v1:...).
Mga Header
| Authorization | Bearer <token> (kinakailangan) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
I-update
https://hexbon.com/api/v1/data
I-save ang iyong naka-encrypt na data. Tumatanggap ng client-encrypted payload (v1:...) sa katawan ng kahilingan.
Tandaan: Dapat paganahin ang write access sa iyong Mga Setting ng API. Bilang default, ang access sa API ay read-only.
Mga Header
| Authorization | Bearer <token> (kinakailangan) |
| Content-Type | application/json (kinakailangan) |
Katawan ng Kahilingan
| data | Client-encrypted payload na nagsisimula sa v1: (kinakailangan) |
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 ng Tugon
Ang lahat ng tugon ng API ay ibinabalik sa format na JSON na may boolean field na success na nagsasaad ng resulta ng operasyon.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Mga Code ng Error
| Code | Paglalarawan |
|---|---|
| 401 | Hindi wasto o nawawalang API key / nag-expire na ang token |
| 403 | Naka-disable ang write access (para sa POST /data) |
| 422 | Hindi wastong format ng payload o lumampas sa limitasyon ng storage |
| 429 | Lumampas sa limitasyon ng rate (10 kahilingan/minuto) |
| 500 | Panloob na error ng server |
Handa nang Magsimula?
Bumuo ng iyong API key at simulan ang pagsasama sa Hexbon ngayon.
Pumunta sa Mga Setting ng API