सीधे कंटेंट पर जाएँ
14 दिन का मुफ़्त ट्रायल, कार्ड नहीं चाहिए9 भाषाएँ176 व्यवसाय प्रकार · 50 ऐप
HI· USD
लाइव डेमो आज़माएँमुफ़्त ट्रायल शुरू करें

इंटीग्रेशन और REST API: कैसे काम करता है

इंटीग्रेशन और API की मदद से दूसरे सॉफ़्टवेयर आपके डेटा के साथ काम कर सकते हैं। API की से कोई दूसरा सिस्टम ग्राहक, लीड, कोटेशन, इनवॉइस, ऑर्डर और प्रोडक्ट पढ़ सकता है और इनमें से कुछ बना भी सकता है, और वेबहुक किसी घटना के होते ही दूसरे सिस्टम को ख़बर देते हैं। इससे अकाउंटिंग टूल, ऑटोमेशन सेवाएँ या अपना ऐप जोड़ें।

पाठ 2 / 9 · कैसे काम करता है

  • लगभग 3 मिनट
  • System → Integrations → Integrations & API

कैसे काम करता है

  1. «System → Integrations → Integrations & API» में ऊपर चार आँकड़े दिखते हैं: «Active keys», «Endpoints», «Delivered (7 d)» और «Failed»। नीचे «API keys», «Webhook endpoints» और «Event catalog» पैनल हैं।

  2. «Create key» दबाएँ, ऐसा नाम दें जिससे पता चले कि की कहाँ इस्तेमाल होगी, उसके स्कोप पर टिक करें और चाहें तो समाप्ति की तारीख़ दें। स्कोप का मतलब है किसी एक तरह के रिकॉर्ड को पढ़ने या लिखने का अधिकार। लिखने में पढ़ना भी शामिल है।

  3. नई की सिर्फ़ एक बार «Your new API key» के नीचे दिखाई जाती है। उसे तुरंत कॉपी करें: सिस्टम में उसका सिर्फ़ फ़िंगरप्रिंट रखा जाता है, इसलिए वह दोबारा नहीं दिखाई जा सकती।

  4. दूसरा सिस्टम हर अनुरोध के साथ यह की भेजता है। वह ग्राहक, लीड, कोटेशन, इनवॉइस, ऑर्डर और प्रोडक्ट की सूची देख और पढ़ सकता है, और ग्राहक, लीड, ड्राफ़्ट कोटेशन और ड्राफ़्ट इनवॉइस बना सकता है।

  5. API से बनी लीड वही संदेश भेजती है जो वेबसाइट फ़ॉर्म से आई लीड। API से बने कोटेशन और इनवॉइस हमेशा ड्राफ़्ट होते हैं और उनमें टैक्स एडमिन एडिटर की तरह ही निकाला जाता है। API उन्हें कभी भेजता नहीं और न ही भुगतान हुआ दर्ज करता है।

  6. हर की की पंक्ति में उसके स्कोप, उसे किसने बनाया, अनुरोधों की संख्या और आख़िरी इस्तेमाल दिखता है, साथ में «Active», «Expired» या «Revoked» का बैज। «Revoke» की को तुरंत बंद कर देता है।

  7. «API docs» डेवलपर के लिए पूरा संदर्भ खोलता है, और «Delivery log» वेबहुक पोस्ट की सूची खोलता है।

कहाँ मिलेगा

इसे बदलने वाली सेटिंग्स

चेकलिस्ट

आगे बढ़ने से पहले जाँच लें कि आप ये कर सकते हैं:

  • System → Integrations → Integrations & API खोलना
  • System → Integrations → Integrations & API में ऊपर चार आँकड़े दिखते हैं: Active keys, Endpoints, Delivered…
  • Create key दबाएँ, ऐसा नाम दें जिससे पता चले कि की कहाँ इस्तेमाल होगी, उसके स्कोप पर टिक करें और चाहें तो…
  • नई की सिर्फ़ एक बार Your new API key के नीचे दिखाई जाती है।
  • दूसरा सिस्टम हर अनुरोध के साथ यह की भेजता है।

टिप्स और आम गलतियाँ

  • की खो गई? उसे वापस नहीं पाया जा सकता। पुरानी की रद्द करें और नई बनाएँ।
  • अगर कोई अनुरोध स्कोप न होने की वजह से अस्वीकार होता है तो की उस अधिकार के बिना बनी थी। वह स्कोप टिक करके नई की बनाएँ।
  • एक की एक साथ 300 अनुरोध कर सकती है और उसके बाद हर सेकंड 5। इससे तेज़ माँगने वाले सिस्टम को रुकने को कहा जाता है, और एक ही पते से बार-बार अस्वीकृति होने पर अस्थायी प्रतिबंध लग सकता है।
  • की को पासवर्ड की तरह सँभालें। हर जुड़े सिस्टम को अलग की दें, ताकि एक को रद्द करने पर बाक़ी बंद न हों।