API कुंजियाँ और API
अन्य प्रणाली को आपके IDup डेटा को पढ़ने और लिखने दें, एक कुंजी के तहत जिसे आप नवीनीकृत या हटा सकते हैं, और API गाइड खोजें।
एक API कुंजी एक पासवर्ड है जो व्यक्ति के बजाय एक प्रोग्राम से संबंधित होता है। इसे उसी तरह से संभालें: प्रति सिस्टम एक जारी करें, और जब वह सिस्टम बदलता है तो इसे बदलें।
एक कुंजी बनाएं
- खोलें API → API प्रबंधन और दबाएँ नई कुंजी.
- उसे ऐसा नाम दें जो बताता हो कि कौन सा सिस्टम इसका उपयोग करता है।
- इसका चयन करें अनुमतियाँ: पूर्ण पहुंच, या केवल वे क्षेत्र जो सिस्टम को चाहिए। अधिकांश क्षेत्रों में पढ़ने, बनाने और बदलने का अंतर होता है।
- एक समाप्ति तिथि चुनें, या कोई नहीं।
- उपयोग करें दिखाएं और प्रतिलिपि बनाएँ चाबी देने के लिए की कार्ड पर, कॉल करने वाले सिस्टम को। सिस्टम इसे भेजता है authtoken हेडर।
प्रत्येक की कार्ड अनुमतियाँ, निर्माण तिथि दिखाता है, अंतिम उपयोग और “सक्रिय” या “5 दिनों में समाप्त” जैसा बैज।
कुंजी समाप्त होने से पहले नवीनीकरण करें
कुंजी समाप्त होने से चौदह दिन पहले, आपको घंटी में एक सूचना मिलती है। दबाएँ नवीनीकरण करें की-कार्ड पर और नई समाप्ति तिथि चुनें। IDup समान अनुमतियों के साथ नई कुंजी बनाता है। इसे तुरंत कॉपी करें, क्योंकि यह डिस्प्ले केवल एक बार दिखता है। पुरानी कुंजी अपनी समाप्ति तक वैध रहती है, ताकि आप बिना अंतराल के सिस्टम बदल सकें।
वह क्षेत्र जो आप पहुंच सकते हैं
एपीआई आपके ग्राहक डेटा को कवर करता है और आपके प्लान के अनुसार, संपत्तियां और किराए, खोज प्रोफाइल, कर फ़ाइलें, ट्रस्टी फ़ाइलें, लेखांकन, पेरोल रन और रसीद स्कैनिंग। एआई स्टूडियो और इनबॉक्स के अपने क्षेत्र हैं। एपीआई गाइड केवल उन्हीं क्षेत्रों को सूचीबद्ध करता है जो आपके प्लान में शामिल हैं।
एपीआई गाइड
खोलें प्रलेखन API प्रबंधन पेज पर टैब, या API → API मार्गदर्शिका. प्रत्येक क्षेत्र अपने फ़ील्ड्स, अनुरोध उदाहरण जिन्हें आप कॉपी कर सकते हैं, उदाहरण उत्तर और त्रुटि कोड दिखाता है।
वेबहुक और अन्य इंटरफ़ेस
- यह Webhooks टैब आपके सिस्टम को घटनाएँ होते ही भेजता है — देखें वेबहुक्स के साथ अपने स्वयं के सिस्टम को घटनाएं भेजें.
- यदि ग्राहक API चालू है, तो एक ग्राहक API सेटिंग्स टैब इसकी सेटिंग्स खोलता है, उदाहरण के लिए क्या ग्राहक API के ज़रिए पंजीकरण कर सकते हैं।
- स्वचालन / कार्यप्रवाह → तकनीकी इंटरफ़ेस GraphQL इंटरफ़ेस के लिए टोकन जारी करता है।
- AI स्टूडियो → व्यक्तिगत API कुंजियाँ कुंजियों का एक अलग सेट है।
इसे सुरक्षित रखना
- प्रति सिस्टम एक कुंजी, कभी साझा नहीं की जाती।
- एक कुंजी को केवल वही अनुमतियाँ दें जो सिस्टम को चाहिए।
- एक समाप्ति तिथि सेट करें और एक शेड्यूल पर नवीनीकरण करें।
- जैसे ही कोई व्यक्ति जो इसे जानता था छोड़ देता है, या सिस्टम बंद कर दिया जाता है, एक कुंजी को हटा दें।
कुछ भी ट्रैक नहीं किया गया — बटन केवल एक संदेश खोलते हैं ताकि आप हमें बता सकें कि क्या गायब था।
