API दस्तावेज़ीकरण
टोकन-आधारित प्रमाणीकरण के साथ हमारे सुरक्षित REST API का उपयोग करके अपने एन्क्रिप्टेड डेटा को प्रोग्रामेटिक रूप से एक्सेस करें।
अध्याय
शुरुआत करें
शुरू करने के लिए अपनी खाता सेटिंग में एक API कुंजी उत्पन्न करें
Hexbon API का उपयोग करने के लिए, आपको अपने खाता सेटिंग → API सेटिंग पृष्ठ से एक API कुंजी उत्पन्न करनी होगी। API बढ़ी हुई सुरक्षा के लिए दो-चरणीय प्रमाणीकरण प्रवाह का उपयोग करता है।
प्रमाणीकरण प्रवाह
टोकन का अनुरोध करें
POST /api/v1/auth के माध्यम से अस्थायी एक्सेस टोकन का अनुरोध करने के लिए अपनी API कुंजी का उपयोग करें
टोकन वैधता
टोकन 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 | आंतरिक सर्वर त्रुटि |
शुरू करने के लिए तैयार हैं?
अपनी API कुंजी उत्पन्न करें और आज ही Hexbon के साथ एकीकरण शुरू करें।
API सेटिंग पर जाएं