मुख्य सामग्री पर जाएं

SDK कार्यान्वयन के लिए सर्वोत्तम प्रथाएं

MarkdownChatGPTClaude

यह पृष्ठ Unico के SDKs को एकीकृत करने और बनाए रखने के लिए सबसे महत्वपूर्ण दिशानिर्देशों को संकलित करता है। इन प्रथाओं का पालन करने से एकीकरण त्रुटियां कम होती हैं, सुरक्षा घटनाओं से बचाव होता है, और उत्पादन में सुचारू रूप से तैनाती सुनिश्चित होती है।

शुरुआत करना​

अपने कार्यान्वयन को सरल बनाने के लिए PoC का उपयोग करें

Unico सभी समर्थित भाषाओं में कार्यात्मक कोड उदाहरणों के साथ Proofs of Concept (PoCs) प्रदान करता है। ये अपेक्षित विधि अनुक्रमों और एकीकरण पैटर्न को प्रदर्शित करते हैं। क्लाइंट पोर्टल सपोर्ट टिकट सिस्टम के माध्यम से उपलब्ध PoCs तक पहुंचें।

अपने SDKs को हमेशा अपडेट रखें

SDKs अधिक सुरक्षा और नई सुविधाएं प्रदान करने के लिए निरंतर विकसित होते हैं। अपडेट को तत्काल लागू करना — विशेष रूप से महत्वपूर्ण अपडेट — आवश्यक है। समयसीमा और दायित्वों के लिए अपडेट नीति देखें।

उपलब्ध नवीनतम संस्करण की पहचान करें

प्रत्येक प्लेटफ़ॉर्म के लिए संबंधित रिलीज़ नोट्स के माध्यम से वर्तमान संस्करण जांचें:

अपडेट रणनीति​

SDK और अन्य घटकों को एक साथ अपडेट करने से बचें

आपका एप्लिकेशन संभवतः Unico SDK के साथ कई लाइब्रेरीज़ लोड करता है। एक साथ कई निर्भरताओं को अपग्रेड करने से विफलताओं के मूल कारण की पहचान करना कठिन हो जाता है। SDK को अलग से अपडेट करें और इसे अन्य बदलावों के साथ मिलाने से पहले staging वातावरण में इसे मान्य करें।

SDK अपडेट में सहायता प्राप्त करना

अपडेट समस्याओं के लिए सपोर्ट टिकट खोलते समय, शामिल करें:

  • SDK भाषा और कार्यान्वयन प्रकार (native या hybrid)
  • उपयोग किया गया फ्रेमवर्क
  • वर्तमान संस्करण और लक्ष्य संस्करण
  • API Key
  • परिवर्तनों का विवरण और पुनः उत्पन्न करने के चरण
  • परिणाम, त्रुटियां, लॉग्स, स्क्रीनशॉट, या वीडियो

JWT सुरक्षा​

JWT ऑब्जेक्ट में हेरफेर न करें
एन्क्रिप्टेड JWT को न खोलें या संशोधित न करें

सफल कैप्चर के बाद लौटाया गया JWT एन्क्रिप्टेड है। इसे खोलें, पार्स करें, या सीरियलाइज़ न करें। इसकी आंतरिक संरचना बिना सूचना के बदल सकती है। इसका उपयोग केवल Unico के APIs को छवियां सबमिट करते समय करें।

छवि पूर्वावलोकन के लिए, JWT के साथ प्रदान की गई Base64 विशेषता का उपयोग करें — JWT को स्वयं कभी डिकोड न करें।

JWT को 10 मिनट के भीतर भेजें
चेतावनी

सुरक्षा कारणों से, JWT को कैप्चर के 10 मिनट के भीतर Unico के बैकएंड को भेजा जाना चाहिए। इस समय-सीमा के बाद सबमिट किए गए पैकेज अमान्य हो जाते हैं।

JWT को केवल एक बार भेजें
चेतावनी

JWT को केवल एक बार सबमिट किया जाना चाहिए। यदि सबमिशन के दौरान कोई त्रुटि होती है, तो एक नई बायोमेट्रिक कैप्चर की आवश्यकता होगी — उसी JWT का पुन: उपयोग न करें।

परीक्षण दिशानिर्देश​

वर्चुअलाइज़ेशन या एमुलेटर का उपयोग न करें

वर्चुअल मशीनों या एमुलेटर में SDK चलाने से सुरक्षा त्रुटि कोड (73006, 73600, 73400) उत्पन्न होते हैं। त्रुटियों की गलत पहचान और अनावश्यक पुनर्कार्य से बचने के लिए हमेशा भौतिक उपकरणों पर परीक्षण करें।

Web कैप्चर के दौरान DevTools को खुला न रखें

Web SDK खुले DevTools को संभावित धोखाधड़ी संकेत के रूप में पहचानता है और सबमिशन को अमान्य कर देता है। एंड-टू-एंड कैप्चर परीक्षण चलाने से पहले DevTools बंद करें।

Unico के staging वातावरण में परीक्षण करें​

उत्पादन में जाने से पहले, यथार्थवादी परिदृश्यों के साथ Unico के staging वातावरण में संपूर्ण परीक्षण करें। Staging-विशिष्ट API Keys और कॉन्फ़िगरेशन का उपयोग करें — परीक्षणों में कभी भी उत्पादन क्रेडेंशियल का उपयोग न करें।

प्लेटफ़ॉर्म-विशिष्ट दिशानिर्देश​

Flutter: Unico के Flutter plugin का उपयोग करें

Flutter एप्लिकेशन के अंदर native Android या iOS SDKs को ब्रिज करने का प्रयास न करें। Native ब्रिज अक्सर अनमैप्ड त्रुटियां उत्पन्न करते हैं। हमेशा Unico के समर्पित Flutter plugin का उपयोग करें।

Web: संस्करण अपडेट करते समय पुरानी रिसोर्स फ़ाइलें हटाएं

Web SDK को अपग्रेड करते समय, नई फ़ाइलें डालने से पहले अपने public फ़ोल्डर से पुरानी रिसोर्स फ़ाइलें हटाएं। समान नाम वाली फ़ाइलें स्वचालित रूप से ओवरराइट नहीं होंगी और संस्करण विरोध उत्पन्न कर सकती हैं।

Mobile: नए संस्करण बनाने से पहले कैश साफ़ करें

पिछले SDK संस्करणों के बिल्ड आर्टिफैक्ट अपडेट के बाद निर्भरता त्रुटियां उत्पन्न कर सकते हैं। नया संस्करण बनाने से पहले:

  • Flutter: pubspec.lock हटाएं और flutter pub get चलाएं
  • iOS: pod cache clean --all और pod install चलाएं
  • Android: ./gradlew clean चलाएं
ऑब्फ़स्केशन सेटिंग्स

Unico SDK कोड को अपने ऑब्फ़स्केशन कॉन्फ़िगरेशन से बाहर रखें। SDK को ऑब्फ़स्केट करने से अक्सर रिलीज़ बिल्ड में विफलताएं होती हैं जो डीबग बिल्ड में नहीं दिखती। आवश्यक keep नियमों के लिए प्लेटफ़ॉर्म-विशिष्ट दस्तावेज़ देखें।

UX और परफ़ॉर्मेंस​

तैयारी और कैमरा खोलने के प्रवाह को दो चरणों में विभाजित करें

SDK प्रवाह को दो अलग-अलग चरणों में संरचित करें:

  1. तैयार करें — SDK को तब इनिशियलाइज़ करें जब पृष्ठ लोड हो रहा हो (उपयोगकर्ता इंटरैक्शन से पहले)।
  2. खोलें — कैमरा केवल तब लॉन्च करें जब उपयोगकर्ता स्पष्ट रूप से कार्रवाई शुरू करे।

SDK को पहले से तैयार करने से अनुभवित विलंबता कम होती है और उपयोगकर्ता अनुभव में महत्वपूर्ण सुधार होता है।

उत्पादन में तैनाती​

उत्पादन तैनाती के लिए एक सुरक्षित चेकलिस्ट बनाएं

उत्पादन में तैनात करने से पहले, सत्यापित करें:

  • उत्पादन API Keys और वातावरण कॉन्फ़िगरेशन सही हैं
  • रोलबैक योजना परिभाषित और परीक्षित है
  • लॉग संग्रह प्रोटोकॉल मौजूद है
  • विफलताओं को संभालने के लिए सपोर्ट टिकट प्रक्रियाएं प्रलेखित हैं
  • Staging वातावरण में सभी मान्यताएं पास हो गई हैं
अंतिम अपडेट को