Skip to content

API एक्सेस

WallaWhats उन्हीं operations को JSON HTTP API के माध्यम से उजागर करता है जो dashboard उपयोग करता है। इसका उपयोग subscription management को script करने, notification history को अपने सिस्टम में लाने, या alerts को internal tools के साथ integrate करने के लिए करें। प्रत्येक paid tier में API एक्सेस शामिल है — प्रति-plan key सीमाओं के लिए अपना plan प्रबंधित करें देखें।

चरण 1 — API कुंजियाँ खोलें

sidebar से, API कुंजियाँ पर क्लिक करें (Access keys के तहत)।

एक डिफ़ॉल्ट कुंजी के साथ API कुंजियाँ पेज

चरण 2 — कुंजी बनाएँ

  1. Create key पर क्लिक करें।
  2. कुंजी को एक नाम दें (जैसे production-server, local-dev)। नाम केवल एक label है — यह permissions को प्रभावित नहीं करता।
  3. Create पर क्लिक करें।

पूर्ण कुंजी मान एक बार दिखाया जाता है — इसे तुरंत अपने secret manager में कॉपी करें। WallaWhats केवल एक hash और एक छोटा prefix (bws_xxxxxxxx…) संग्रहीत करता है, इसलिए इसे बाद में पुनर्प्राप्त नहीं किया जा सकता।

कुंजियों को passwords की तरह मानें

कुंजी वाला कोई भी आपके खाते पर कार्य कर सकता है। कुंजियों को secret manager में संग्रहीत करें, उन्हें git में commit न करें, और समय-समय पर rotate करें।

चरण 3 — कुंजी का उपयोग करें

हर request पर x-api-key header में कुंजी भेजें:

bash
curl -H "x-api-key: bws_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  https://api.wallawhats.com/subscriptions

उपलब्ध endpoints, request bodies, और response shapes API Reference में documented हैं।

चरण 4 — Rotate या revoke

  • Rotate — एक नई कुंजी बनाएँ, deploy करें, फिर पुरानी हटाएँ। design के अनुसार कोई "rotate" बटन नहीं है; create-then-delete cutover को atomic बनाता है।
  • Revoke — कुंजी पंक्ति के बगल में Delete पर क्लिक करें। कुंजी तुरंत काम करना बंद कर देती है। इसका उपयोग करने वाले कोई भी in-flight requests 401 Unauthorized लौटाते हैं।

Plan सीमाएँ

PlanAPI कुंजियाँ
Free1
Pro1
Pro+2
Business5
Enterprise20

यदि आप सीमा तक पहुँचते हैं, तो Create key अक्षम हो जाती है — पहले एक पुरानी कुंजी हटाएँ या अपना plan upgrade करें।

आगे क्या

request/response schemas और पूर्ण endpoint सूची के लिए, API Reference → देखें।

WallaWhats Documentation