हर डिवाइस के लिए एक कॉन्ट्रैक्ट। पाँच क्षमता समूहों में 38 ऑपरेशन, सिंक्रोनस REST कॉल और रियल-टाइम Callback webhooks के रूप में उपलब्ध।
सभी REST कॉल एक ही वर्ज़न वाले होस्ट पर की जाती हैं।
https://api.camsbiometrics.com/v3/
हर रिक्वेस्ट में आपके अकाउंट और डिवाइस तक सीमित AuthToken होती है। की डेवलपर पोर्टल से जारी की जाती हैं।
फ़ॉर्म-एन्कोडेड या JSON रिक्वेस्ट। रिस्पॉन्स JSON में होते हैं, जिनमें फ़ील्ड और एरर कोड अनुमानित होते हैं।
इंटीग्रेट करने के दो तरीके
आप गेटवे को कॉल करते हैं और तुरंत जवाब पाते हैं। उपस्थिति लाने, यूज़र्स की सूची बनाने, किसी को एनरोल करने या ज़रूरत पर दरवाज़ा खोलने के लिए एकदम सही।
एक URL रजिस्टर करें और डिवाइस के रिपोर्ट करते ही गेटवे इवेंट आपको पुश करता है — बिना पोलिंग, विफलता पर स्वचालित रीट्राई के साथ।
ऑपरेशन
काम के अनुसार समूहित। नाम गेटवे के मूल endpoints से 1:1 मेल खाते हैं।
पूरे अकाउंट में किसी तारीख़ सीमा के सभी पंच।
किसी एक कर्मचारी कोड के लिए एक अवधि के लॉग।
एक डिवाइस सीरियल नंबर द्वारा कैप्चर किए गए पंच।
प्रति-दिन, प्रति-कर्मचारी सारांश (इन/आउट, घंटे)।
प्रति कर्मचारी प्रति दिन फ़र्स्ट-इन / लास्ट-आउट जोड़ी।
आज के पंच का लाइव स्नैपशॉट।
पंच के साथ जुड़ी कैप्चर की गई फ़ोटो, जहाँ समर्थित हो।
पेरोल और रिकंसिलिएशन के लिए बल्क एक्सपोर्ट।
एक या अधिक डिवाइसों पर यूज़र बनाएँ।
नाम, रोल, वैधता या विशेषाधिकार संपादित करें।
किसी डिवाइस से यूज़र हटाएँ।
कोड से यूज़र खोजें, वैकल्पिक क्रेडेंशियल के साथ।
किसी डिवाइस पर एनरोल सभी लोगों की सूची।
दिखाएँ कि यूज़र किन डिवाइसों पर मौजूद है।
डिवाइस पर फ़िंगरप्रिंट टेम्पलेट पुश करें।
फ़ेस टेम्पलेट रजिस्टर करें, जहाँ समर्थित हो।
यूज़र को RFID / प्रॉक्सिमिटी कार्ड असाइन करें।
डिवाइस PIN / पासवर्ड सेट या बदलें।
डिवाइसों के बीच यूज़र्स और टेम्पलेट क्लोन करें।
यूज़र का डेटा डिवाइस क्यू में फिर से भेजें।
डोर रिले, टर्नस्टाइल, फ़्लैप, स्विंग या बूम बैरियर को रियल टाइम में ट्रिगर करें।
दरवाज़े को अपने नियंत्रण में लॉक / होल्ड करें।
वर्तमान खुली / बंद स्थिति पढ़ें।
समय-आधारित एक्सेस विंडो परिभाषित करें।
एंट्री / एग्ज़िट और दरवाज़े के इवेंट का लॉग।
हर जुड़े डिवाइस की इन्वेंटरी।
मॉडल, फ़र्मवेयर, क्षमता और काउंटर।
ऑनलाइन स्थिति, अंतिम बार देखा गया और क्यू की गहराई।
अभी किसी डिवाइस की पहुँच की पुष्टि करें।
डिवाइस की घड़ी को सर्वर के साथ मिलाएँ।
डिवाइस को दूर से रीस्टार्ट करें।
क्यू से अटके कमांड साफ़ करें।
क्यू में रखे कमांड की स्थिति ट्रैक करें।
लाइव इवेंट के लिए webhook URL सब्सक्राइब करें।
हर पंच पर रियल टाइम में ट्रिगर होता है।
ऑनलाइन / ऑफ़लाइन और हेल्थ में बदलाव।
टेम्पलेट के डिवाइस पर पहुँचने की पुष्टि।
बल्क डिवाइस / डेटा माइग्रेशन की प्रगति ट्रैक करें।
अनुमानित रिस्पॉन्स
| कोड | अर्थ | क्या करें |
|---|---|---|
200 | सफल | JSON पेलोड प्रोसेस करें। |
401 | AuthToken अमान्य या अनुपस्थित | API की और डिवाइस पेयरिंग जाँचें। |
404 | डिवाइस या यूज़र नहीं मिला | सीरियल नंबर / कर्मचारी कोड सत्यापित करें। |
409 | डिवाइस ऑफ़लाइन / क्यू में | कमांड क्यू में है; GetCommandStatus पोल करें। |
429 | रेट लिमिट लागू | रुकें और जिटर के साथ दोबारा कोशिश करें। |
क्विकस्टार्ट आपको API की से लेकर पहले उपस्थिति लॉग तक मिनटों में पहुँचाता है।
हम ट्रैफ़िक मापने और BiometricAPI.com को बेहतर बनाने के लिए कुकीज़ का उपयोग करते हैं। आपके स्वीकार करने तक एनालिटिक्स बंद रहता है। और जानें।