API कुंजियों से अपना सॉफ़्टवेयर जोड़ें

सार्वजनिक API आपके या आपके डेवलपर के सॉफ़्टवेयर को Kluvan रिकॉर्ड पढ़ने और लिखने देता है: उत्पाद, ग्राहक, स्टॉक, रिपोर्ट, Books दस्तावेज़, HR के लोग, CRM, सदस्यता और उपलब्ध ऐप। हर कुंजी आपके नियंत्रण में है: क्या कर सकती है, कितने समय तक और किस शाखा के लिए।

शुरू करने से पहले

• केवल मालिक कुंजियाँ बना और रद्द कर सकता है।
• कुंजी संगठन में अनुपलब्ध ऐप नहीं खोलती और प्लान, ऐप तथा शाखाओं के सभी नियम लागू रहते हैं।

चरण

1. सेटिंग्स → डेवलपर पहुँच खोलें।
2. नई कुंजी में पहचानने योग्य नाम लिखें, जैसे "गोदाम स्कैनर"।
3. इतने दिन मान्य (1–365) सेट करें। डिफ़ॉल्ट 90 है।
4. शाखा में सभी शाखाएँ रखें या एक शाखा चुनें।
5. देख सकती है में हर ज़रूरी दायरा टिक करें। हर दायरा पढ़ें या लिखें कहता है, जैसे उत्पाद · पढ़ें।
6. चुनी पहुँच की अनुमति देने वाला वाक्य टिक करें।
7. कुंजी बनाएँ दबाएँ।
8. कुंजी अभी कॉपी करें। सिर्फ़ इसी बार दिखाई जाती है।
9. सॉफ़्टवेयर को कुंजी दें। वह Authorization: Bearer हेडर में भेजता है।

API कॉल करना

• पता https://api.kluvan.com/v1/public-api है। डेवलपर गाइड (/developers) उदाहरण और हर ऑपरेशन का ज़रूरी दायरा दिखाती है। OpenAPI 3.1 अनुरोध फ़ील्ड सहित पूरा अनुबंध डाउनलोड करता है।
• हर लेखन के लिए Idempotency-Key चाहिए: हर बदलाव का नया UUID। जवाब खो जाए तो 7 दिन तक वही अनुरोध उसी कुंजी से दोबारा भेजें; वह दो बार लागू नहीं होता। बदले अनुरोध के साथ वही कुंजी अस्वीकार होती है।
• मौजूदा रिकॉर्ड बदलने पर उसका वर्तमान संस्करण (v) भी भेजते हैं, ताकि पुरानी कॉपी नई को न बदल दे।
• रकम मुद्रा की सबसे छोटी इकाई में है (150.00 को 15000)।
• ऐप रिकॉर्ड सूचियाँ अधिकतम 50 रिकॉर्ड और next मान लौटाती हैं; अगला पेज लेने के लिए इसे after में दें।
• प्रति कुंजी प्रति मिनट अधिकतम 120 अनुरोध। इसके बाद Retry-After के साथ 429 उत्तर आता है। हर त्रुटि का कोड है (त्रुटि गाइड देखें)।

जानने योग्य बातें

• लिखने के दायरे असली रिकॉर्ड बदलते हैं और स्टॉक तथा अकाउंटिंग प्रभावों सहित ऐप कार्य चला सकते हैं। कुंजी को केवल ज़रूरी दायरे दें।
• शाखा कुंजियाँ केवल शाखा रिकॉर्ड पढ़ती हैं। कैटलॉग, ग्राहक, CRM, HR और सदस्यता ऑपरेशन के लिए सभी शाखाओं वाली कुंजी चाहिए।
• Kluvan हर कुंजी का सिर्फ़ फ़िंगरप्रिंट (हैश) रखता है। कुंजी खो गई? रद्द करके नई बनाएँ।
• रद्द करें कुंजी तुरंत रोकता है। अंतिम दिन भी कुंजी बंद होती है। अधिकतम 20 कुंजियाँ रख सकते हैं।
• API गतिविधि हर कॉल का समय, ऑपरेशन, कुंजी और स्थिति दिखाती है। अनुरोध बॉडी और कुंजियाँ कभी दर्ज नहीं होतीं।
• API में बिलिंग, साइन इन, पेमेंट संग्रह या वेबहुक नहीं हैं: बाहर भेजी सूचनाएँ नहीं होतीं, इसलिए आपका सॉफ़्टवेयर ज़रूरी सूचियाँ पढ़ता है।
• साइन इन किया ब्राउज़र सत्र इस API को कॉल नहीं कर सकता और सहायक ऐप की कुंजियाँ अलग हैं: सहायक ऐप जोड़ें देखें।