इस एपीआई का उपयोग क्लाइंट के व्यक्तिगत प्रोजेक्ट में बॉटहेल्प क्षमताओं को एकीकृत करने के लिए किया जाता है। यह एपीआई डेवलपर्स और इसके साथ दस्तावेज़ भी उपलब्ध हैं।
इन सेटिंग्स के साथ काम करने के लिए विकास कौशल होना या किसी अनुभवी विशेषज्ञ से संपर्क करना महत्वपूर्ण है।
विवरण
BotHelp REST API HTTP प्रोटोकॉल के माध्यम से काम करता है और यह विधियों का एक समूह है जो प्रत्येक ऑपरेशन के लिए अनुरोध करता है और प्रतिक्रियाएँ लौटाता है। सभी प्रतिक्रियाएँ JSON संरचनाओं के रूप में आती हैं।
अनुरोधों की संख्या की सीमा विशिष्ट विधि पर निर्भर करती है ( दस्तावेज़ीकरण )।
क्रॉस-डोमेन अनुरोध (जैसे jQuery Ajax) की अनुमति नहीं है।
मुख्य यूआरएल
इस दस्तावेज़ में API अनुरोधों के सभी संदर्भों में आवश्यक आधार URL शामिल है:
https://api.bothelp.io
प्राधिकार
प्राधिकरण प्रक्रिया तभी संभव है जब कोई व्यक्तिगत कुंजी (टोकन) हो, जिसका उपयोग API के प्रत्येक अनुरोध पर हस्ताक्षर करने के लिए किया जाना चाहिए।
कुंजी कोड (टोकन) किसी भी अनुरोध के हेडर में ("हेडर" में) प्रेषित किया जाता है, सिवाय टोकन प्राप्त करने के मामलों को छोड़कर, जब इस कोड की आवश्यकता नहीं होती है।
कुंजी प्राप्त करने के लिए आवश्यक पैरामीटर खाता सेटिंग में पाए जा सकते हैं: "एकीकरण" अनुभाग देखें।
कुंजी प्राप्त करने के लिए, लिंक पर एक POST अनुरोध भेजा जाता है:
https://oauth.bothelp.io/oauth2/token
प्राधिकरण टोकन प्राप्त करने के लिए, आपको Form-data ।
अनुरोध पैरामीटर:
grant_type client_credentials के बराबर होना चाहिए
client_id आपकी आईडी (API)
client_secret आपका सीक्रेट (API)
उदाहरण उत्तर:
{
"access_token": "tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc",
"token_type": "वाहक",
"expires_in": 3600
}
उदाहरण कुंजी:
प्राधिकरण: Bearer tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc
नोट: कृपया ध्यान दें कि प्राप्त कुंजी 1 घंटे के लिए मान्य है और प्रत्येक ऑपरेशन के लिए पुनः अनुरोध की आवश्यकता नहीं है। जब कुंजी की समय सीमा समाप्त हो जाती है (1 घंटा), तो आपको पुनः अनुरोध करना होगा।
संभावनाएं
आप उपलब्ध विधियों की सूची यहां ।
ग्राहक डेटा के साथ क्रियाएँ:
- ग्राहकों की सूची डाउनलोड करें;
- ग्राहक पैरामीटर बदलें;
- कस्टम पैरामीटर का मान सेट करें;
- टैग सेट/हटाएँ;
- किसी विशिष्ट ईमेल से अपने सब्सक्राइबर के बारे में सारी जानकारी प्राप्त करें। आप ईमेल फ़िल्टर का उपयोग करके ऐसा कर सकते हैं;
- ग्राहक को संदेश भेजें.
बॉट के साथ क्रियाएँ:
- किसी निश्चित चरण पर बॉट में एक ग्राहक जोड़ें,
- ग्राहक के लिए बॉट बंद करो.
ऑटो-मेलिंग के साथ क्रियाएँ:
- ऑटो-मेलिंग सूची में एक ग्राहक जोड़ें,
- ग्राहक को ऑटो-मेलिंग से हटाएँ।
प्रतिबंध
प्लेटफ़ॉर्म के स्थिर संचालन को सुनिश्चित करने के लिए, प्रत्येक API विधि में प्रति सेकंड अनुरोधों की संख्या की एक निर्धारित सीमा होती है।
| आप LIMIT | समापन बिंदुओं पर लागू होता है |
|---|---|
| 10 अनुरोध/सेकंड | - /v1/subscribers/{id}/customFields- /v1/subscribers/cuid/{cuid}/customFields- /v1/bots/{bot_referral}/steps- /v1/funnels/- /v1/subscribers/{id}/messages- /v1/bots/ |
| 25 अनुरोध/सेकंड | - /v1/ग्राहक/cuid/{cuid}/संदेश- /v1/ग्राहक/cuid/फ़नल- /v1/ग्राहक/cuid/{cuid}/फ़नल- /v1/ग्राहक/cuid/आईडी}/बॉट- /v1/ग्राहक/cuid/फ़नल |
अनुशंसा: निर्दिष्ट सीमाओं से अधिक होने से बचने के लिए अनुरोध कतार और विराम का उपयोग करें।
महत्वपूर्ण : सभी BotHelp टैरिफ पर, बाहरी अनुरोध और वेबहुक की कार्यक्षमता समान है
___________________________________________________________________
यदि आपको अपने प्रश्न का उत्तर नहीं मिला है, तो अपने खाते के अंदर चैट में हमसे पूछें या BotHelpSupportBot या hello@bothelp.io पर
मेलिंग, ऑटोफ़नल और चैटबॉट्स बॉटहेल्प बनाने के लिए प्लेटफ़ॉर्म की 14 दिनों की पूर्ण कार्यक्षमता प्राप्त करें।