मदद केंद्र / डेवलपर के लिए

API और वेबहुक

API keys, वेबहुक और OAuth ऐप से दूसरे सॉफ़्टवेयर को अपने स्टोर से जोड़ें।

API keys

API कुंजियाँ → Create key। दिखते ही उसे कॉपी कर लें — यह bzk_ से शुरू होती है और सिर्फ़ एक बार दिखती है। हर कॉल पर इसे भेजें:

curl https://<your-store-address>/api/public/products \
  -H "Authorization: Bearer bzk_your_key"

/api/public के मुख्य endpoints:

Endpoint क्या करता है
GET /products प्रोडक्ट की सूची।
POST /products प्रोडक्ट बनाना।
GET /orders?status= ऑर्डर की सूची, चाहें तो स्टेटस से।
GET /catalog?format= कैटलॉग एक्सपोर्ट (CSV / फ़ीड फ़ॉर्मैट)।
GET /webhooks, POST /webhooks, DELETE /webhooks/{id} वेबहुक संभालना।

Keys को पासवर्ड की तरह संभालें; किसी key को बंद करने के लिए उसे API कुंजियाँ में डिलीट करें।

हर endpoint, field और response API reference में है — अपने स्टोर के पते (या BazaarSaaS के पते) पर /api/reference — जहाँ आप अपनी key से कॉल आज़मा भी सकते हैं।

वेबहुक

वेबहुक → Add endpoint — अपना URL और चाहे गए इवेंट (order.confirmed, order.shipped) डालें। BazaarSaaS आपके URL पर JSON भेजता (POST) है, जिस पर X-BazaarSaaS-Signature हेडर में आपके endpoint के secret से हस्ताक्षर होता है — कॉल पर भरोसा करने से पहले इसे जाँचें। फ़ेल हुई डिलीवरी दोबारा भेजी जाती है; अपना endpoint आज़माने के लिए Send test (एक ping इवेंट) इस्तेमाल करें।

ऐप (OAuth)

जो सॉफ़्टवेयर कई स्टोरों के लिए काम करता है, वह key की जगह OAuth से जुड़ता है: व्यापारी ऐप के माँगे scopes को मंज़ूर करता है, और ऐप को उन्हीं scopes तक सीमित एक bzoauth_ token मिलता है। ऐप ऐप्स में रजिस्टर करें।

फिर भी अटके? हमसे बात करें — हम सेट करने में मदद करेंगे। हमसे बात करें