मुख्य सामग्री पर जाएं
Wbiztool

प्रोडक्ट गाइड

API की

Wbiztool API या आपके क्रेडेंशियल मांगने वाले किसी इंटीग्रेशन का उपयोग करने के लिए आपको डैशबोर्ड से तीन चीज़ें चाहिए:

क्रेडेंशियलAPI फील्डकहां मिलेगा
API Client IDclient_idसेटिंग्स → API Keys, पेज में सबसे ऊपर
API कीapi_keyसेटिंग्स → API Keys
WhatsApp Client IDwhatsapp_clientWhatsApp सेटिंग्स पर WhatsApp क्लाइंट ID कॉलम

शुरू करने से पहले#

  • API की देखने, बनाने या डिलीट करने के लिए आपको वर्कस्पेस का प्रशासक (Administrator) होना चाहिए। देखें भूमिकाएं और अनुमतियां।
  • पहले सही वर्कस्पेस चुनें। की उसी वर्कस्पेस की होती है जो उसे बनाते समय चुना हुआ था, और उस की से की गई API रिक्वेस्ट उसी वर्कस्पेस पर काम करती हैं। देखें वर्कस्पेस बदलें।
  • डेमो अकाउंट API का उपयोग नहीं कर सकते।

अपना API Client ID ढूंढें#

सेटिंग्स → API Keys खोलें। API ओवरव्यू कार्ड में API क्लाइंट ID: के बाद एक नंबर दिखता है। हर रिक्वेस्ट में इस नंबर को client_id के रूप में इस्तेमाल करें। वर्कस्पेस की हर की के लिए यह एक ही होता है।

API की बनाएं#

  1. API Keys खोलें

    सेटिंग्स पर जाएं और API Keys टैब पर क्लिक करें, या सीधे /settings/#api-keys खोलें।

  2. की बनाएं

    नई API Key के नीचे नया बनाएं पर क्लिक करें। एक सफलता संदेश बताता है कि की बन गई है, और वह टेबल में दिखने लगती है।

  3. पूरी की कॉपी करें

    API Key कॉलम में हर की की सिर्फ शुरुआत और अंत दिखता है। पूरी की कॉपी करने के लिए उसके पास वाले कॉपी बटन (पूरी API Key कॉपी करें) पर क्लिक करें, फिर उसे अपने ऐप या इंटीग्रेशन में पेस्ट करें।

की के नाम वर्कस्पेस में मौजूद की की संख्या के आधार पर अपने आप रखे जाते हैं (API Key 1, API Key 2 और इसी तरह आगे) और इनका नाम बदला नहीं जा सकता। किसी की को डिलीट करने के बाद, नई की को वही नाम मिल सकता है जो किसी मौजूदा की का है, इसलिए की को उनके पहले और आखिरी अक्षरों और Created तारीख से पहचानें। की एक्सपायर नहीं होतीं: की तब तक काम करती है जब तक आप उसे डिलीट न करें।

लिमिट#

एक वर्कस्पेस में एक समय पर ज़्यादा से ज़्यादा 10 API की हो सकती हैं। लिमिट पूरी होने पर आपको "You have reached the maximum limit of 10 API keys per organization." (आप प्रति संगठन 10 API की की अधिकतम सीमा तक पहुंच गए हैं।) दिखता है। नई की बनाने के लिए कोई ऐसी की डिलीट करें जिसका अब आप उपयोग नहीं करते।

API की टेबल#

कॉलममतलब
लेबलकी का नाम, जैसे API Key 1।
API Keyकी के पहले और आखिरी अक्षर। पूरी की के लिए कॉपी बटन का उपयोग करें।
बनाया गयाकी बनने की तारीख।
स्टेटसहमेशा सक्रिय। डिलीट की गई की टेबल से हटा दी जाती हैं।
कार्यहटाएं की को हटा देता है।

API की डिलीट करें#

  1. की ढूंढें

    सेटिंग्स → API Keys पर टेबल में की ढूंढें।

  2. उसे डिलीट करें

    हटाएं पर क्लिक करें, फिर हाँ, API Key हटाएं पर।

की डिलीट करना वापस नहीं किया जा सकता। उसे अभी भी इस्तेमाल कर रहा कोई भी ऐप तुरंत काम करना बंद कर देता है और उसे Auth Error: invalid api key मिलता है। पहले अपने ऐप में नई की डालें।

WhatsApp Client ID#

हर कनेक्टेड WhatsApp नंबर का अपना ID होता है। ज़्यादातर मैसेजिंग एंडपॉइंट को संदेश भेजने वाला नंबर चुनने के लिए whatsapp_client फील्ड में यह ID चाहिए।

WhatsApp सेटिंग्स खोलें और हर नंबर के पास WhatsApp क्लाइंट ID कॉलम देखें। अगर आपने अभी तक कोई नंबर कनेक्ट नहीं किया है, तो देखें अपना WhatsApp नंबर कनेक्ट करें।

अपने क्रेडेंशियल टेस्ट करें#

अपने client_id और api_key, और चाहें तो whatsapp_client, के साथ क्रेडेंशियल जांचें (POST /api/v1/me/) कॉल करें। यह कुछ भेजे बिना और कोई संदेश खर्च किए बिना कन्फर्म करता है कि ये एक साथ काम करते हैं। अगर whatsapp_client उस वर्कस्पेस का नहीं है, तो रिस्पॉन्स Invalid WhatsApp Client ID होता है।

अगर API की लीक हो जाए#

जिसके पास भी आपकी API की और API Client ID है, वह आपके WhatsApp नंबरों से संदेश भेज सकता है और आपके वर्कस्पेस के संदेश खर्च कर सकता है।

  1. बदले में नई की बनाएं

    सेटिंग्स → API Keys पर नया बनाएं पर क्लिक करें और नई की कॉपी करें।

  2. अपने ऐप अपडेट करें

    जिन ऐप और इंटीग्रेशन में पुरानी की इस्तेमाल हो रही थी, उन सब में उसे बदलें।

  3. लीक हुई की डिलीट करें

    लीक हुई की पर हटाएं पर क्लिक करें। वह तुरंत काम करना बंद कर देती है।

  4. गलत इस्तेमाल जांचें

    रिपोर्ट्स पर हाल के संदेश देखें कि कहीं ऐसा कुछ तो नहीं जो आपने नहीं भेजा।

"WbizTool Alert - WhatsApp Connected Successfully!" ईमेल को भी गोपनीय रखें: यह किसी नंबर के पहली बार कनेक्ट होने पर वर्कस्पेस के निर्माता को भेजा जाता है और इसमें आपकी कोई एक API की हो सकती है।

समस्या निवारण#

समस्याक्या जांचें
API Keys टैब में कोई API Keys नहीं मिलीं दिखता है, जबकि की मौजूद हैंआप इस वर्कस्पेस में Administrator नहीं हैं, या कोई दूसरा वर्कस्पेस चुना हुआ है।
"You don't have permission to create API keys in this space."सिर्फ Administrators की बना या डिलीट कर सकते हैं। खाली टेबल में नई API Key जनरेट करें (Generate New API Key) बटन सभी को दिखता है, लेकिन सिर्फ Administrators के लिए काम करता है।
"You have reached the maximum limit of 10 API keys per organization."कोई ऐसी की डिलीट करें जिसका अब आप उपयोग नहीं करते।
Auth Error: invalid api keyकी डिलीट हो गई है या गलत टाइप हुई है, या client_id उसी वर्कस्पेस का नहीं है जिसकी की है। अगर नई की और पेज पर दिखने वाले API Client ID के साथ भी यह फेल हो, तो सपोर्ट से संपर्क करें (पुराने वर्कस्पेस में ऐसा API Client ID दिख सकता है जो सिर्फ वर्कस्पेस बनाने वाले व्यक्ति की बनाई की के साथ काम करता है)।
Auth Error - Please send correct API key and Client idरिक्वेस्ट में api_key नहीं है।
Invalid client id. (या कुछ endpoint पर Invalid Client Id)client_id नहीं भेजा गया या वह नंबर नहीं है। क्रेडेंशियल जांचें पर, client_id या api_key न भेजने पर सिर्फ Auth Error मिलता है; वहां Invalid Client Id का मतलब है कि वह नंबर नहीं है। इसे API ओवरव्यू कार्ड से कॉपी करें।
रिक्वेस्ट गलत वर्कस्पेस पर काम करती हैंकी किसी दूसरे वर्कस्पेस में बनाई गई थी। वर्कस्पेस बदलें और वहां की बनाएं।
Demo Account can not access apisडेमो अकाउंट API का उपयोग नहीं कर सकते। मुफ्त अकाउंट के लिए साइन अप करें।

संबंधित#