सीधे मुख्य कॉन्टेंट पर जाएं

डेवलपर API और वेबहुक

डेवलपर सेंटर से API कुंजियाँ बनाएँ, वेबहुक एंडपॉइंट पंजीकृत करें, और अनुरोध लॉग की समीक्षा करें।

Sarah Chen द्वारा लिखा गया

Developer Center वह जगह है जहाँ आप Exayard को अपने स्वयं के कोड और टूल से जोड़ते हैं। इसे Settings फिर Developer से खोलें। यहाँ से आप API कुंजियाँ बनाते हैं, वेबहुक एंडपॉइंट रजिस्टर करते हैं, और हर API रिक्वेस्ट का एक लाइव लॉग देखते हैं। केवल संगठन एडमिन ही इस पेज तक पहुँच सकते हैं।

API keys

एक API key Exayard API के लिए रिक्वेस्ट को प्रमाणित करती है। कुंजियाँ आपके संगठन की होती हैं, इसलिए सही अकाउंट अपने आप चुना जाता है और कोई संगठन ID पास करने की ज़रूरत नहीं होती।

Credentials कार्ड में API keys टैब खोलें और + बटन पर क्लिक करें। कुंजी को एक Name दें, फिर उसके Scopes चुनें। हर स्कोप देने के लिए All चुनें, या व्यक्तिगत अनुमतियाँ चुनने के लिए Specific चुनें। स्कोप प्रति संसाधन एक रीड और राइट विभाजन का पालन करते हैं, जैसे read:projects और write:estimatesadmin:org स्कोप एक पूर्ण-पहुँच अनुदान है। अपने एकीकरण के लिए आवश्यक न्यूनतम स्कोप चुनें।

Exayard पूरी कुंजी एक बार दिखाता है, ठीक उसे बनाने के बाद। उसे तभी कॉपी कर लें, क्योंकि यह दोबारा कभी नहीं दिखाई जाती। उसके बाद, हर कुंजी अपने नाम, ak_••••1234 जैसे एक मास्क किए गए प्रीव्यू, और अंतिम बार उपयोग की तारीख के साथ दिखाई देती है।

किसी कुंजी का नाम बदलने या उसके स्कोप बदलने के लिए पेंसिल आइकन का उपयोग करें। इसे Revoke करने के लिए ट्रैश आइकन का उपयोग करें। रद्द करना स्थायी होता है और उस कुंजी का उपयोग करने वाला कोई भी एकीकरण तुरंत काम करना बंद कर देता है।

वही कुंजी नो-कोड एकीकरणों को प्रमाणित करती है। देखें Exayard को Zapier से जोड़ना, Exayard को Make से जोड़ना, और Exayard को n8n से जोड़ना। एजेंट और AI-एडिटर पहुँच के लिए, Claude और अन्य AI टूल से जोड़ना देखें।

Webhooks

एक webhook Exayard को निर्देश देता है कि जब कुछ हो तो आपके सर्वर को सूचित करे। Webhooks टैब खोलें और एक एंडपॉइंट जोड़ने के लिए + पर क्लिक करें। वह URL दर्ज करें जिसे डिलीवरी प्राप्त करनी चाहिए और एक वैकल्पिक Description

चुनें कि किन Events की सदस्यता लेनी है। हर घटना प्राप्त करने के लिए All चुनें, या सूची से चुनने के लिए Specific चुनें:

घटना

कब सक्रिय होती है

project.created

कोई प्रोजेक्ट बनता है

project.updated

कोई प्रोजेक्ट बदला जाता है

project.archived

कोई प्रोजेक्ट आर्काइव किया जाता है

assessment.started

कोई टेकऑफ़ असेसमेंट शुरू होता है

assessment.completed

कोई असेसमेंट समाप्त होता है

assessment.approved

कोई असेसमेंट अनुमोदित होता है

assessment.cancelled

कोई असेसमेंट रद्द होता है

estimate.generated

कोई एस्टीमेट जनरेट होता है

bid.generated

कोई बिड जनरेट होता है

file.processed

कोई अपलोड की गई फ़ाइल प्रोसेस होना समाप्त करती है

जब आप कोई एंडपॉइंट बनाते हैं, तो Exayard एक signing secret एक बार दिखाता है। उसे तभी कॉपी कर लें, क्योंकि यह दोबारा नहीं दिखाई जाती।

Securing webhook deliveries

हर डिलीवरी t=<unix>,v1=<digest> के रूप में एक Exayard-Signature हेडर ले जाती है। Exayard टाइमस्टैम्प और रिक्वेस्ट बॉडी को जोड़कर सिग्नेचर बनाता है, फिर उन्हें आपके एंडपॉइंट सीक्रेट का उपयोग करके HMAC-SHA256 से साइन करता है।

किसी डिलीवरी को सत्यापित करने के लिए, अपने सीक्रेट से सिग्नेचर की पुनर्गणना करें, पुष्टि करें कि टाइमस्टैम्प अभी से पाँच मिनट के भीतर है, और डाइजेस्ट की तुलना करें। विफल डिलीवरी लगभग तीन दिनों तक एक्सपोनेंशियल बैकऑफ़ के साथ फिर से प्रयास करती हैं।

किसी एंडपॉइंट को संपादित करने के लिए, पेंसिल आइकन पर क्लिक करें। आप URL, विवरण और घटनाएँ बदल सकते हैं, और इसके Status को Active या Paused पर सेट कर सकते हैं। पॉज़ किए गए एंडपॉइंट डिलीवरी प्राप्त करना बंद कर देते हैं। उसी डायलॉग में एक Rotate secret बटन होता है। रोटेट करने से एक नया सीक्रेट जारी होता है और पुराना तुरंत काम करना बंद कर देता है, इसलिए रोटेट करने से पहले अपना सर्वर अपडेट करें। ट्रैश आइकन किसी एंडपॉइंट को हटा देता है और उसे होने वाली सभी डिलीवरी समाप्त कर देता है।

Quick start

Quick start कार्ड में Claude या Cursor जैसे किसी AI एडिटर के लिए एक तैयार प्रॉम्प्ट होता है। Copy prompt पर क्लिक करें और इसे अपने एडिटर में पेस्ट करें। प्रॉम्प्ट में API बेस URL, प्रमाणीकरण फ़ॉर्मेट, स्कोप शब्दावली, और वेबहुक साइनिंग स्कीम शामिल होते हैं, ताकि AI एक काम करने वाला एकीकरण तैयार कर सके और आपसे ज़रूरी विवरण माँग सके।

Documentation

Documentation कार्ड पूर्ण डेवलपर दस्तावेज़ और OpenAPI spec से लिंक करता है, जो हर रूट और स्कीमा का वर्णन करता है। Connect MCP AI एजेंट को सीधे Exayard से जोड़ने का सेटअप खोलता है।

Logs

Logs सेक्शन REST API और MCP दोनों में आपकी सबसे हाल की API रिक्वेस्ट रिकॉर्ड करता है। हर पंक्ति मेथड, पाथ, रिस्पॉन्स स्टेटस और लेटेंसी दिखाती है। किसी पंक्ति का पूरा विवरण देखने के लिए उसे चुनें, जिसमें रिक्वेस्ट ID और रिक्वेस्ट व रिस्पॉन्स बॉडी शामिल हैं। यह पुष्टि करने के लिए कि कोई कॉल काम कर गया या किसी विफल एकीकरण को डीबग करने के लिए लॉग का उपयोग करें।

क्या इससे आपके सवाल का जवाब मिला?