एकीकरण मार्गदर्शिका
घटनाओं और वेबहूक
मान्य परीक्षा प्रवेश द्वार
आप एक उत्तरदाता को मान्य कर सकते हैं जो एक परीक्षा लेने वाला है और इस उपयोगकर्ता के बारे में मेटाडेटा भी जोड़ सकता है.
जब एक उत्तरदाता एक परीक्षा शुरू करने के लिए अनुरोध करता है, तो हमारा सर्वर आपके सर्वर URL के लिए एक WebHook अनुरोध करेगा कि यदि प्रतिवादी क्रेडेंशियल (जैसे ईमेल, पासवर्ड या मैट्रिक संख्या) मान्य हैं.
आपका सर्वर इस प्रतिवादी के बारे में कुछ मेटाडेटा के साथ वैकल्पिक प्रतिक्रिया दे सकता है, जैसे name, email, photo, about and data.
नीचे उदाहरण आपके सर्वर से किए गए अनुरोध और अपेक्षित प्रतिक्रिया की नकल करता है यदि सत्यापन सफल था
जब एक उत्तरदाता एक परीक्षा शुरू करने के लिए अनुरोध करता है, तो हमारा सर्वर आपके सर्वर URL के लिए एक WebHook अनुरोध करेगा कि यदि प्रतिवादी क्रेडेंशियल (जैसे ईमेल, पासवर्ड या मैट्रिक संख्या) मान्य हैं.
आपका सर्वर इस प्रतिवादी के बारे में कुछ मेटाडेटा के साथ वैकल्पिक प्रतिक्रिया दे सकता है, जैसे name, email, photo, about and data.
नीचे उदाहरण आपके सर्वर से किए गए अनुरोध और अपेक्षित प्रतिक्रिया की नकल करता है यदि सत्यापन सफल था
कृपया ध्यान दें कि आपको 60 सेकंड के भीतर जवाब देने की उम्मीद है या अनुरोध हमारे सर्वर द्वारा समाप्त हो जाएगा.
यदि प्रतिवादी आपके सर्वर द्वारा मान्य नहीं किया जा सकता है, तो आपको प्रदान करने की उम्मीद है errorMessage कारण के साथ, और आपको इसे छोड़ने की उम्मीद है.आप वैकल्पिक रूप से प्रदान कर सकते हैं metadata यदि सत्यापन सफल रहा.
इसके अलावा, यदि आप प्रतिवादी पर फेस डिटेक्शन करने का इरादा रखते हैं, तो आपको प्रदान करने की उम्मीद है metadata.photo प्रतिवादी की एक तेज छवि के लिंक के साथ। अनुशंसित छवि रिज़ॉल्यूशन एक छवि है जो 1500x1500 पिक्सेल से अधिक है।
यदि प्रतिवादी आपके सर्वर द्वारा मान्य नहीं किया जा सकता है, तो आपको प्रदान करने की उम्मीद है errorMessage कारण के साथ, और आपको इसे छोड़ने की उम्मीद है.आप वैकल्पिक रूप से प्रदान कर सकते हैं metadata यदि सत्यापन सफल रहा.
इसके अलावा, यदि आप प्रतिवादी पर फेस डिटेक्शन करने का इरादा रखते हैं, तो आपको प्रदान करने की उम्मीद है metadata.photo प्रतिवादी की एक तेज छवि के लिंक के साथ। अनुशंसित छवि रिज़ॉल्यूशन एक छवि है जो 1500x1500 पिक्सेल से अधिक है।
सुनिश्चित करें x-client-id and x-client-secret अनुरोध हेडर पर
{
"event": "verify_respondent",
"fields": [
{
"position": 0,
"value": "Some valid student id"
},
{
"position": 1,
"value": "Some valid student password"
}
],
"exam_id": "some unique exam_id",
"choosenLang": "ru"
}नीचे उदाहरण आपके सर्वर और अपेक्षित प्रतिक्रिया के लिए किए गए अनुरोध की नकल करता है यदि सत्यापन विफल हो गया
{
"event": "verify_respondent",
"fields": [
{
"position": 0,
"value": "Some invalid student id"
},
{
"position": 1,
"value": "Some invalid student password"
}
],
"exam_id": "some unique exam_id..",
"choosenLang": "ru"
}सुनिश्चित करें कि आप सक्षम हैं validate fields via webhook परीक्षा निर्माण पृष्ठ में
या यदि आप डेवलपर एपीआई का उपयोग कर रहे हैं, तो सुनिश्चित करें welcomePage.validate क्या सच है
या यदि आप डेवलपर एपीआई का उपयोग कर रहे हैं, तो सुनिश्चित करें welcomePage.validate क्या सच है
अपना WebHook URL सेट करना
आप अपने सर्वर WebHook URL को सेट और बदल सकते हैं, यहाँ कैसे है
सेटिंग्स पर नेविगेट करें।
डेवलपर अनुभाग पर जाएं।
Edit and copy your webhook url
प्रतिवादी घटना को स्वीकार करें
हमारा सर्वर आपके सर्वर को सूचित करेगा जब एक उत्तरदाता को परीक्षा देने के लिए भर्ती कराया गया हो। नीचे उदाहरण इस परिदृश्य को प्रदर्शित करता है
respondent_id इस प्रतिवादी के बारे में अतिरिक्त जानकारी देखने के लिए
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}परिणाम तैयार घटना
हमारे सर्वर आपके सर्वर को सूचित करेंगे जब एक परीक्षा के लिए एक उत्तरदाता परिणाम तैयार हो जाएगा। नीचे उदाहरण इस परिदृश्य को प्रदर्शित करता है
respondent_id इस प्रतिवादी के लिए परिणाम डेटा देखने के लिए
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}जांच पूर्ण घटना
जब एक प्रतिवादी पर जांच पूरी हो जाती है तो हमारा सर्वर आपके सर्वर को सूचित करेगा। नीचे उदाहरण इस परिदृश्य को प्रदर्शित करता है
respondent_id इस प्रतिवादी के बारे में अतिरिक्त जानकारी देखने के लिए
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}प्रतिक्रिया टिप्पणियाँ (0)
