Dokumentasi API
Akses data yang disulitkan anda secara atur cara menggunakan API REST selamat kami dengan pengesahan berasaskan token.
Bab
Bermula
Jana kunci API dalam tetapan akaun anda untuk bermula
Untuk menggunakan API Hexbon, anda perlu menjana kunci API dari halaman Tetapan Akaun → Tetapan API anda. API menggunakan aliran pengesahan dua langkah untuk keselamatan yang dipertingkatkan.
Aliran Pengesahan
Minta Token
Gunakan kunci API anda untuk meminta token akses sementara melalui POST /api/v1/auth
Kesahihan Token
Token sah selama 60 minit. Selepas tamat tempoh, minta token baharu.
Gunakan Token
Sertakan token dalam pengepala Authorization: Bearer <token> untuk operasi data.
Had Kadar
API dihadkan kepada 10 permintaan seminit bagi setiap pengguna. Melebihi had ini akan menghasilkan respons 429 Too Many Requests.
Titik Akhir
Sahkan
https://hexbon.com/api/v1/auth
Jana token akses sementara menggunakan kunci API anda.
Pengepala
| X-API-Key | Kunci API anda (wajib) |
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
}
Baca
https://hexbon.com/api/v1/data
Ambil data yang disulitkan anda. Mengembalikan muatan yang disulitkan pelanggan (v1:...).
Pengepala
| Authorization | Bearer <token> (wajib) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Kemas Kini
https://hexbon.com/api/v1/data
Simpan data yang disulitkan anda. Menerima muatan yang disulitkan pelanggan (v1:...) dalam badan permintaan.
Nota: Akses tulis mesti didayakan dalam Tetapan API anda. Secara lalai, akses API adalah baca sahaja.
Pengepala
| Authorization | Bearer <token> (wajib) |
| Content-Type | application/json (wajib) |
Badan Permintaan
| data | Muatan yang disulitkan pelanggan bermula dengan v1: (wajib) |
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 Respons
Semua respons API dikembalikan dalam format JSON dengan medan boolean success yang menunjukkan hasil operasi.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Kod Ralat
| Kod | Penerangan |
|---|---|
| 401 | Kunci API tidak sah atau hilang / token tamat tempoh |
| 403 | Akses tulis dilumpuhkan (untuk POST /data) |
| 422 | Format muatan tidak sah atau had storan dilebihi |
| 429 | Had kadar dilebihi (10 permintaan/minit) |
| 500 | Ralat pelayan dalaman |
Bersedia untuk Bermula?
Jana kunci API anda dan mulakan integrasi dengan Hexbon hari ini.
Pergi ke Tetapan API