เอกสาร API
เข้าถึงข้อมูลที่เข้ารหัสของคุณโดยทางโปรแกรมโดยใช้ REST API ที่ปลอดภัยของเราพร้อมการตรวจสอบสิทธิ์แบบโทเค็น
บท
เริ่มต้นใช้งาน
สร้างคีย์ API ในการตั้งค่าบัญชีของคุณเพื่อเริ่มต้น
ในการใช้ Hexbon API คุณต้องสร้างคีย์ API จากหน้า การตั้งค่าบัญชี → การตั้งค่า API ของคุณ API ใช้ขั้นตอนการตรวจสอบสิทธิ์แบบสองขั้นตอนเพื่อความปลอดภัยที่เพิ่มขึ้น
ขั้นตอนการตรวจสอบสิทธิ์
ขอโทเค็น
ใช้คีย์ API ของคุณเพื่อขอโทเค็นการเข้าถึงชั่วคราวผ่าน POST /api/v1/auth
ความถูกต้องของโทเค็น
โทเค็นมีอายุ 60 นาที หลังจากหมดอายุ ให้ขอโทเค็นใหม่
ใช้โทเค็น
รวมโทเค็นในส่วนหัว Authorization: Bearer <token> สำหรับการดำเนินการข้อมูล
การจำกัดอัตรา
API ถูกจำกัดไว้ที่ 10 คำขอต่อนาทีต่อผู้ใช้ การเกินขีดจำกัดนี้จะส่งผลให้เกิดการตอบกลับ 429 Too Many Requests
จุดสิ้นสุด
ตรวจสอบสิทธิ์
https://hexbon.com/api/v1/auth
สร้างโทเค็นการเข้าถึงชั่วคราวโดยใช้คีย์ API ของคุณ
ส่วนหัว
| X-API-Key | คีย์ API ของคุณ (จำเป็น) |
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
}
อ่าน
https://hexbon.com/api/v1/data
ดึงข้อมูลที่เข้ารหัสของคุณ ส่งคืนเพย์โหลดที่เข้ารหัสโดยไคลเอนต์ (v1:...)
ส่วนหัว
| Authorization | Bearer <token> (จำเป็น) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
อัปเดต
https://hexbon.com/api/v1/data
บันทึกข้อมูลที่เข้ารหัสของคุณ ยอมรับเพย์โหลดที่เข้ารหัสโดยไคลเอนต์ (v1:...) ในเนื้อหาคำขอ
หมายเหตุ: ต้องเปิดใช้งานการเข้าถึงการเขียนใน การตั้งค่า API ของคุณ โดยค่าเริ่มต้น การเข้าถึง API เป็นแบบอ่านอย่างเดียว
ส่วนหัว
| Authorization | Bearer <token> (จำเป็น) |
| Content-Type | application/json (จำเป็น) |
เนื้อหาคำขอ
| data | เพย์โหลดที่เข้ารหัสโดยไคลเอนต์เริ่มต้นด้วย v1: (จำเป็น) |
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."
}
รูปแบบการตอบกลับ
การตอบกลับ API ทั้งหมดจะถูกส่งคืนในรูปแบบ JSON พร้อมฟิลด์บูลีน success ที่ระบุผลลัพธ์ของการดำเนินการ
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
รหัสข้อผิดพลาด
| รหัส | คำอธิบาย |
|---|---|
| 401 | คีย์ API ไม่ถูกต้องหรือหายไป / โทเค็นหมดอายุ |
| 403 | การเข้าถึงการเขียนถูกปิดใช้งาน (สำหรับ POST /data) |
| 422 | รูปแบบเพย์โหลดไม่ถูกต้องหรือเกินขีดจำกัดการจัดเก็บ |
| 429 | เกินขีดจำกัดอัตรา (10 คำขอ/นาที) |
| 500 | ข้อผิดพลาดภายในเซิร์ฟเวอร์ |