सामग्री पर जाएँ
All articles
Setup

REST API और API कुंजियाँ (इंटीग्रेशन)

CRM को अन्य सिस्टम के साथ REST API के माध्यम से एकीकृत करें, कुंजी द्वारा प्रमाणित।

Sellio एक REST API प्रदान करता है ताकि आप अन्य सिस्टम (Zapier, Make, आपकी अपनी स्क्रिप्ट्स, आदि) से रिकॉर्ड पढ़ और लिख सकें। पहुँच एक API कुंजी द्वारा प्रमाणित होती है जिसे आप सेटिंग्स → API और कुंजियाँ में जनरेट करते हैं।

कुंजी जनरेट करें

  1. सेटिंग्स → API और कुंजियाँ पर जाएँ।
  2. इसे एक नाम दें (जैसे "Zapier इंटीग्रेशन") और "कुंजी जनरेट करें" पर क्लिक करें।
  3. कुंजी को तुरंत कॉपी करें: यह केवल एक बार दिखाई देती है और बाद में पुनर्प्राप्त नहीं की जा सकती।
  4. किसी इंटीग्रेशन को बंद करने के लिए, "रद्द करें" का उपयोग करें, और कुंजी तुरंत काम करना बंद कर देती है।
💡 कुंजी आपके संगठन के डेटा तक पूर्ण पहुँच देती है। इसे पासवर्ड की तरह व्यवहार करें: इसे कभी भी सार्वजनिक कोड या ब्राउज़र में उजागर न करें।

एंडपॉइंट

  • GET /api/v1/{object}: रिकॉर्ड सूचीबद्ध करता है (पैरामीटर: limit, offset, search)।
  • GET /api/v1/{object}/{id}: एक एकल रिकॉर्ड।
  • POST /api/v1/{object}: एक रिकॉर्ड बनाता है (फ़ील्ड के साथ JSON बॉडी)।
  • PATCH /api/v1/{object}/{id}: किसी रिकॉर्ड के फ़ील्ड अपडेट करता है।

हेडर Authorization: Bearer sk_live_… में कुंजी भेजें। {object} ऑब्जेक्ट का API नाम है (contact, company, lead, opportunity या आपका अपना कोई ऑब्जेक्ट)।

Example: curl -H "Authorization: Bearer sk_live_..." https://www.selliocrm.com/api/v1/opportunity
💡 API CRM के सत्यापन और व्यावसायिक नियमों (आवश्यक फ़ील्ड, सत्यापन नियम, आदि) का पालन करता है, बिल्कुल वैसे ही जैसे स्क्रीन के माध्यम से उपयोग करने पर होता है।

रेट लिमिट और उपयोग (SLA)

प्रत्येक कुंजी में प्रति मिनट अनुरोधों की एक सीमा होती है (डिफ़ॉल्ट 120), जिसे कुंजी सूची में ही समायोजित किया जा सकता है। हर प्रतिक्रिया में हेडर X-RateLimit-Limit (सीमा), X-RateLimit-Remaining (वर्तमान विंडो में कितने और फिट होते हैं) और X-RateLimit-Reset (epoch में वह क्षण, जब विंडो रीसेट होती है) होते हैं।

जब आप सीमा पार करते हैं, तो API 429 (Too Many Requests) के साथ जवाब देता है, जिसमें Retry-After हेडर बताता है कि फिर से प्रयास करने से पहले कितने सेकंड इंतज़ार करना है। कुंजी स्क्रीन प्रत्येक कुंजी द्वारा पहले से किए गए कुल अनुरोध भी दिखाती है (उपयोग मीट्रिक)।

💡 अपने आयतन के अनुसार सीमा सेट करें: 0 उस कुंजी के लिए सीमा को अक्षम करता है। तृतीय-पक्ष इंटीग्रेशन के लिए एक छोटी सीमा और भरोसेमंद आंतरिक लोड के लिए एक बड़ी सीमा का उपयोग करें।

Open this article inside the system

Read it and want to see it working?

The account is free and the whole manual is available inside the system, with an assistant that answers from this very content.

मुफ़्त खाता बनाएँ
REST API और API कुंजियाँ (इंटीग्रेशन) · Sellio