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

शुरुआत

क्रेडेंशियल जांचें API

दूसरे API कॉल करने से पहले अपने क्रेडेंशियल जांचने के लिए इस API का इस्तेमाल करें। यह पक्का करता है कि आपका client_id और api_key साथ में सही काम कर रहे हैं, और चाहें तो यह भी कि कोई WhatsApp नंबर ID आपके वर्कस्पेस का है। यह कुछ भी नहीं भेजता और कोई क्रेडिट खर्च नहीं करता।

POSThttps://wbiztool.com/api/v1/me/

बॉडी: JSON या फॉर्म फील्ड

छोटा उदाहरण#

curl -X POST https://wbiztool.com/api/v1/me/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678
  }'

12345, YOUR_API_KEY और 678 की जगह अपनी वैल्यू डालें। अगर आप सिर्फ की टेस्ट करना चाहते हैं, तो whatsapp_client न भेजें। ये कहां मिलेंगी, यह जानने के लिए ऑथेंटिकेशन देखें।

रिक्वेस्ट पैरामीटर#

client_idintegerआवश्यक

सेटिंग्स → API Keys से आपका API क्लाइंट ID।

api_keystringआवश्यक

उसी पेज से आपकी API की।

whatsapp_clientintegerवैकल्पिक

WhatsApp सेटिंग्स से आपके किसी WhatsApp नंबर का ID। इसे भेजने पर यह भी जांचा जाता है कि यह ID इस API की वाले वर्कस्पेस का है। डैशबोर्ड से डिलीट किया गया नंबर भी यह जांच पास कर लेता है। यह सिर्फ ID जांचता है; यह नहीं बताता कि नंबर कनेक्टेड है या नहीं। उसके लिए कनेक्शन स्टेटस इस्तेमाल करें।

रिस्पॉन्स#

सफल रिक्वेस्ट HTTP 200 लौटाती है:

{
  "status": 1,
  "message": "Okay",
  "name": "[email protected] - 919876543210"
}
फील्डटाइपविवरण
statusintegerक्रेडेंशियल सही हों तो 1, वरना 0
messagestringसफल होने पर Okay, वरना एरर।
namestringउस व्यक्ति का यूज़रनेम जिसने वर्कस्पेस बनाया था। अगर आपने whatsapp_client भेजा है, तो - के बाद उस नंबर का फोन नंबर जोड़ा जाता है। केवल सफल होने पर मौजूद होता है।

एरर#

इस एंडपॉइंट पर हर विफलता HTTP 400 लौटाती है, सिवाय ऐसे client_id के जो नंबर नहीं है; उस पर HTTP 403 मिलता है। बॉडी में status हमेशा 0 होता है:

{ "status": 0, "message": "Auth Error: invalid api key" }
संदेशकैसे ठीक करें
Auth Errorclient_id और api_key दोनों को POST बॉडी में, सही JSON या फॉर्म फील्ड के रूप में भेजें। यह संदेश तब भी आता है जब whatsapp_client नंबर नहीं होता।
Invalid Client Idclient_id को पूर्ण संख्या के रूप में भेजें, जैसे 12345
Auth Error: invalid api keyजांचें कि की मौजूद है, डिलीट नहीं हुई है और इसी client_id की है।
Invalid WhatsApp Client IDवह whatsapp_client ID इस API की वाले वर्कस्पेस में नहीं है। ID को WhatsApp सेटिंग्स से कॉपी करें।

API चालू है या नहीं, यह जांचना#

/api/v1/status/ एक आसान लाइवनेस चेक है। इसे किसी क्रेडेंशियल की ज़रूरत नहीं होती, यह कोई भी मेथड स्वीकार करता है और हमेशा यह लौटाता है:

{ "status": 200, "data": {} }

यह सिर्फ बताता है कि API तक पहुंचा जा सकता है। यह आपके क्रेडेंशियल या आपके WhatsApp नंबर के कनेक्ट होने की जांच नहीं करता।

curl https://wbiztool.com/api/v1/status/

Python क्लाइंट का health_check() इसी एंडपॉइंट को कॉल करता है।

सुझाव#

  • सेटअप के समय एक बार जांचें: हर संदेश से पहले नहीं, बल्कि जब कोई यूज़र आपके ऐप में अपने क्रेडेंशियल सेव करे तब यह एंडपॉइंट कॉल करें। सफल जांच का मतलब यह नहीं है कि आप संदेश भेज सकते हैं: यह आपके बचे हुए क्रेडिट या आपका नंबर कनेक्टेड है या नहीं, यह नहीं देखती।
  • एरर पर बॉडी पढ़ें: विफलताएं HTTP 400 या 403 के साथ आती हैं, इसलिए पक्का करें कि आपका HTTP क्लाइंट फिर भी JSON बॉडी पार्स करे।
  • डिलीट की गई की तुरंत काम करना बंद कर देती है: अगर कोई की API Keys पेज पर डिलीट की गई है, तो आपको Auth Error: invalid api key मिलेगा।
  • अगला कदम: क्रेडेंशियल काम करने लगें, तो संदेश भेजें