وثائق API
الوصول إلى بياناتك المشفرة برمجياً باستخدام واجهة برمجة التطبيقات REST الآمنة الخاصة بنا مع المصادقة القائمة على الرمز المميز.
الفصول
البدء
قم بإنشاء مفتاح API في إعدادات حسابك للبدء
لاستخدام Hexbon API، تحتاج إلى إنشاء مفتاح API من صفحة إعدادات الحساب → إعدادات API الخاصة بك. تستخدم واجهة برمجة التطبيقات تدفق مصادقة من خطوتين لتعزيز الأمان.
تدفق المصادقة
طلب رمز مميز
استخدم مفتاح API الخاص بك لطلب رمز وصول مؤقت عبر POST /api/v1/auth
صلاحية الرمز المميز
الرمز المميز صالح لمدة 60 دقيقة. بعد انتهاء الصلاحية، اطلب رمزاً جديداً.
استخدام الرمز المميز
قم بتضمين الرمز المميز في رأس Authorization: Bearer <token> لعمليات البيانات.
تحديد المعدل
تقتصر واجهة برمجة التطبيقات على 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 الخاصة بك. بشكل افتراضي، يكون الوصول إلى واجهة برمجة التطبيقات للقراءة فقط.
الرؤوس
| 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 | خطأ داخلي في الخادم |