- Beranda
- Dokumentasi API
Dokumentasi API
Akses data terenkripsi Anda secara terprogram menggunakan REST API aman kami dengan otentikasi berbasis token.
Bab
Memulai
Buat kunci API di pengaturan akun Anda untuk memulai
Untuk menggunakan API Hexbon, Anda perlu membuat kunci API dari halaman Pengaturan Akun → Pengaturan API Anda. API menggunakan alur otentikasi dua langkah untuk keamanan yang ditingkatkan.
Alur Otentikasi
Minta Token
Gunakan kunci API Anda untuk meminta token akses sementara melalui POST /api/v1/auth
Validitas Token
Token berlaku selama 60 menit. Setelah kedaluwarsa, minta token baru.
Gunakan Token
Sertakan token di header Authorization: Bearer <token> untuk operasi data.
Batas Kecepatan
API dibatasi hingga 10 permintaan per menit per pengguna. Melebihi batas ini akan menghasilkan respons 429 Too Many Requests.
Titik Akhir
Otentikasi
https://hexbon.com/api/v1/auth
Buat token akses sementara menggunakan kunci API Anda.
Header
| 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 terenkripsi Anda. Mengembalikan payload terenkripsi klien (v1:...).
Header
| 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..."
}
Perbarui
https://hexbon.com/api/v1/data
Simpan data terenkripsi Anda. Menerima payload terenkripsi klien (v1:...) di badan permintaan.
Catatan: Akses tulis harus diaktifkan di Pengaturan API Anda. Secara default, akses API hanya baca.
Header
| Authorization | Bearer <token> (wajib) |
| Content-Type | application/json (wajib) |
Badan Permintaan
| data | Payload terenkripsi klien dimulai 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 bidang boolean success yang menunjukkan hasil operasi.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Kode Kesalahan
| Kode | Deskripsi |
|---|---|
| 401 | Kunci API tidak valid atau hilang / token kedaluwarsa |
| 403 | Akses tulis dinonaktifkan (untuk POST /data) |
| 422 | Format payload tidak valid atau batas penyimpanan terlampaui |
| 429 | Batas kecepatan terlampaui (10 permintaan/menit) |
| 500 | Kesalahan server internal |
Siap untuk Memulai?
Buat kunci API Anda dan mulai integrasi dengan Hexbon hari ini.
Buka Pengaturan API