Chaindoc REST API संदर्भ

Chaindoc REST API का पूर्ण एंडपॉइंट संदर्भ। प्रमाणीकरण, दस्तावेज़, हस्ताक्षर, मीडिया अपलोड, एम्बेडेड सत्र और ब्लॉकचेन सत्यापन को कवर करता है।

अवलोकन

यह API आपको Chaindoc में सब कुछ प्रोग्रामेटिक रूप से एक्सेस करने की सुविधा देता है: दस्तावेज़, हस्ताक्षर, ब्लॉकचेन सत्यापन और टीम प्रबंधन। वास्तव में, यह सर्वर-टू-सर्वर उपयोग के लिए डिज़ाइन किया गया है और सार्वजनिक और गुप्त API कुंजी दोनों का समर्थन करता है।

• दस्तावेज़ — ब्लॉकचेन पर दस्तावेज़ बनाएं, अपडेट करें और सत्यापित करें
• हस्ताक्षर — हस्ताक्षर अनुरोध भेजें और पूर्णता ट्रैक करें
• मीडिया — PDF, इमेज और वीडियो अपलोड करें (प्रति अनुरोध अधिकतम 10)
• एम्बेडेड सत्र — अपने फ्रंटएंड के लिए हस्ताक्षर सत्र बनाएं (Embed SDK का उपयोग करता है)
• KYC — Sumsub एकीकरण के माध्यम से पहचान डेटा साझा और सत्यापित करें

प्रमाणीकरण

प्रत्येक अनुरोध को Authorization हेडर में API कुंजी की आवश्यकता होती है। दो प्रकार उपलब्ध हैं:

कुंजी के प्रकार

• सार्वजनिक कुंजी (`pk_`) — केवल-पढ़ने योग्य, फ्रंटएंड कोड के लिए सुरक्षित
• गुप्त कुंजी (`sk_`) — पूर्ण पढ़ने/लिखने की अनुमति, केवल बैकएंड। क्लाइंट-साइड कोड में कभी उजागर न करें।

अपनी कुंजी प्राप्त करना

API कुंजी का उपयोग करना

अपनी API कुंजी को Authorization हेडर में Bearer प्रमाणीकरण के साथ शामिल करें:

curl -X GET https://api.chaindoc.io/api/v1/me \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx"

रेट लिमिटिंग

API एंडपॉइंट्स को दुरुपयोग रोकने के लिए रेट-लिमिट किया जाता है। यहाँ बात यह है कि विभिन्न एंडपॉइंट प्रकारों के लिए सीमाएं अलग-अलग होती हैं।

• सामान्य एंडपॉइंट्स: 10 सेकंड में 3 अनुरोध
• मीडिया अपलोड: 10 सेकंड में 3 अनुरोध
• OTP सत्यापन: 60 सेकंड में 5 अनुरोध
• पढ़ने के संचालन: 60 सेकंड में 10 अनुरोध
• हस्ताक्षर निर्माण: 3 सेकंड में 20 अनुरोध

जब रेट सीमा पार हो जाती है, तो आपको 429 Too Many Requests प्रतिक्रिया मिलेगी। प्रतिक्रिया में रेट लिमिट हेडर शामिल हैं:

X-RateLimit-Limit: 3
X-RateLimit-Remaining: 2
X-RateLimit-Reset: 1640000000

त्रुटि प्रबंधन

HTTP स्थिति कोड

• 200 — सफल
• 201 — संसाधन सफलतापूर्वक बनाया गया
• 400 — बुरा अनुरोध (सत्यापन त्रुटि)
• 401 — अनधिकृत (अमान्य या गायब API कुंजी)
• 403 — निषिद्ध (अपर्याप्त अनुमतियां)
• 404 — संसाधन नहीं मिला
• 429 — बहुत अधिक अनुरोध (रेट सीमा पार)
• 500 — आंतरिक सर्वर त्रुटि

त्रुटि प्रतिक्रिया प्रारूप

{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request",
  "details": [
    {
      "field": "name",
      "message": "name must be a string"
    }
  ]
}

सामान्य API

API कुंजी जानकारी प्राप्त करें

वर्तमान API कुंजी के बारे में जानकारी प्राप्त करें।

GET /me

Authorization: Bearer sk_live_xxxxx

हैल्थ चेक

API कनेक्टिविटी और कुंजी वैधता सत्यापित करें।

GET /health

Authorization: Bearer sk_live_xxxxx

दस्तावेज़ API

दस्तावेज़ बनाएं

ब्लॉकचेन सत्यापन के साथ एक नया दस्तावेज़ बनाएं। जब स्थिति 'published' पर सेट होती है, तो दस्तावेज़ स्वचालित रूप से ब्लॉकचेन पर सत्यापित हो जाता है।

POST /documents

Headers:
Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

दस्तावेज़ अपडेट करें

एक नया संस्करण बनाकर दस्तावेज़ अपडेट करें। पिछले संस्करण ऑडिट ट्रेल के लिए संरक्षित रहते हैं।

PUT /documents/:documentId

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

दस्तावेज़ एक्सेस अधिकार अपडेट करें

दस्तावेज़ एक्सेस कंट्रोल सेटिंग्स अपडेट करें।

PUT /documents/:documentId/rights

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

दस्तावेज़ सत्यापित करें

ब्लॉकचेन का उपयोग करके दस्तावेज़ प्रामाणिकता सत्यापित करें। ट्रांजेक्शन हैश और चेन आईडी के साथ सत्यापन स्थिति वापस करता है।

POST /documents/verify

{
  "versionHash": "0x123abc...",
  "certificateHash": "0x456def..."
}

सत्यापन स्थिति प्राप्त करें

दस्तावेज़ संस्करण के लिए ब्लॉकचेन सत्यापन स्थिति प्राप्त करें।

GET /documents/versions/:versionId/verification

Authorization: Bearer sk_live_xxxxx

हस्ताक्षर API

हस्ताक्षर अनुरोध बनाएं

एक या अधिक प्राप्तकर्ताओं के लिए हस्ताक्षर अनुरोध बनाएं। फ्रंटएंड एकीकरण के लिए एम्बेडेड फ्लो सक्षम करें।

curl -X POST https://api.chaindoc.io/api/v1/signatures/requests \
  -H "Authorization: Bearer sk_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "versionId": "f0b7721f-0399-4035-9b69-7b95d3a367f0",
    "recipients": [{"email": "signer@example.com"}],
    "deadline": "2024-12-31T23:59:59Z",
    "embeddedFlow": true
  }'

हस्ताक्षर अनुरोध स्थिति प्राप्त करें

हस्ताक्षर अनुरोध की स्थिति जांचें और देखें कि किन हस्ताक्षरकर्ताओं ने हस्ताक्षर पूरा किया है।

GET /signatures/requests/:requestId/status

Authorization: Bearer sk_live_xxxxx

दस्तावेज़ पर हस्ताक्षर करें

दस्तावेज़ पर हस्ताक्षर करें (यदि API कुंजी मालिक हस्ताक्षरकर्ता है)।

POST /signatures/sign

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

उपयोगकर्ता हस्ताक्षर प्राप्त करें

प्रमाणित उपयोगकर्ता के लिए सभी हस्ताक्षर प्राप्त करें।

GET /signatures

Authorization: Bearer sk_live_xxxxx

हस्ताक्षर अनुरोध प्राप्त करें

पेजिनेशन समर्थन के साथ प्रमाणित उपयोगकर्ता के लिए सभी हस्ताक्षर अनुरोध प्राप्त करें।

GET /signatures/requests?pageNumber=1&pageSize=10

Authorization: Bearer sk_live_xxxxx

मीडिया अपलोड API

दस्तावेज़ निर्माण में उपयोग के लिए फाइलें अपलोड करें। PDF, इमेज और वीडियो का समर्थन करता है। प्रति अनुरोध अधिकतम 10 फाइलें।

curl -X POST https://api.chaindoc.io/api/v1/media/upload \
  -H "Authorization: Bearer sk_live_xxxxx" \
  -F "media=@contract.pdf"

KYC API

KYC डेटा साझा करें

पहचान सत्यापन के लिए प्राप्तकर्ताओं के साथ KYC (Know Your Customer) डेटा साझा करें।

POST /kyc/share

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

एम्बेडेड सत्र API

अपने फ्रंटएंड एप्लिकेशन में दस्तावेज़ हस्ताक्षर के लिए एम्बेडेड सत्र बनाएं। सत्र 10 मिनट के लिए वैध हैं।

POST /embedded/sessions

Authorization: Bearer sk_live_xxxxx
Content-Type: application/json

आगे क्या करें

• API एकीकरण — सामान्य पैटर्न, सर्वोत्तम अभ्यास और पूर्ण वर्कफ्लो उदाहरण
• SDKs — सर्वर SDK और Embed SDK फ्रेमवर्क-विशिष्ट गाइड के साथ
• Webhooks — रीयल-टाइम इवेंट अधिसूचनाएं सेटअप करें
• Installation — सभी समर्थित फ्रेमवर्क के लिए npm सेटअप
• Security — API कुंजी प्रबंधन और अनुपालन