REST API, TypeScript SDK और वेबहुक से अपने उपकरणों को ऑर्डर, उपलब्ध स्टॉक और शिपमेंट ट्रैकिंग से जोड़ें।
अपने खाते के लिए उपलब्ध API और अपने परिवेश में उपलब्ध SDK देखने के लिए डेवलपर पोर्टल खोलें। साइन इन करना और खाते की उपयुक्त अनुमतियाँ होना ज़रूरी है।
TypeScript का SDK
यह सर्वर पर चलने वाला TypeScript उदाहरण Ysend के व्यावसायिक कार्यों के क्लाइंट का उपयोग करता है। जुड़ने की प्रक्रिया के दौरान सहमत API आधार URL कॉन्फ़िगर करें और API कुंजी सर्वर के परिवेश चरों में रखें।
import { Ysend } from "@ysend/sdk";
const ysend = new Ysend({
baseUrl: process.env.YSEND_API_BASE_URL!,
apiKey: process.env.YSEND_API_KEY!,
});
const stock = await ysend.inventory.listBalances({ page: 1, pageSize: 20 });
const orders = await ysend.orders.list({ status: "Open", page: 1, pageSize: 20 });
const shipments = await ysend.shipments.list({ page: 1, pageSize: 20 });इस उदाहरण के लिए inventory:read, orders:read और shipments:read चाहिए। SDK से लिखने की कार्रवाइयों में एक स्थिर Idempotency-Key दें, ताकि पुनः प्रयास करने पर दूसरी कार्रवाई न बने।
Node.js 20 या उसके बाद का संस्करण इस्तेमाल करें। यदि पोर्टल पर SDK उपलब्ध है, तो उसका संस्करण और फ़ाइल का नाम लिख लें, फिर डाउनलोड की गई फ़ाइल का SHA-256 सत्यापित करें। नीचे दिए PACKAGE_FILE.tgz की जगह वही सटीक फ़ाइल नाम डालें।
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL में सहमत API का मूल पता होना चाहिए: HTTPS प्रोटोकॉल और होस्ट, बिना /api/v1 के। SDK यह पथ स्वयं जोड़ता है। YSEND_API_KEY को सर्वर पर रखें; अनुरोध X-Api-Key का उपयोग करते हैं।
सूची के हर अनुरोध से एक पृष्ठ मिलता है। page और pageSize तय करें, फिर अगले पृष्ठ माँगने से पहले उत्तर में उपलब्ध items, totalCount, page और pageSize देखें। पहला पृष्ठ पूर्ण निर्यात नहीं है।
YsendError उपलब्ध HTTP स्थिति, detail और traceId देता है। YsendTransportError का अर्थ है कि उपयोग करने योग्य उत्तर नहीं मिला; ऐसी स्थिति में लिखने की कार्रवाई का परिणाम अज्ञात हो सकता है।
डिफ़ॉल्ट रूप से कुल तीन प्रयास होते हैं और हर प्रयास में उत्तर के हेडर के लिए 30 सेकंड तक प्रतीक्षा की जाती है। नेटवर्क त्रुटि या HTTP 429, 502, 503 या 504 के बाद GET/HEAD और Idempotency-Key वाले अनुरोधों को दोहराया जा सकता है। उसी कार्रवाई के लिए उसी कुंजी का दोबारा उपयोग करें। orders.list इस कुंजी के बिना POST का उपयोग करता है, इसलिए उसमें ये स्वचालित पुनः प्रयास नहीं होते।
एकीकरण संबंधी पूछताछ में अपने उपकरणों और उस डेटा का विवरण दें जिसका आप आदान-प्रदान करना चाहते हैं। हमारी टीम आपके संगठन के लिए उपयुक्त API दस्तावेज़, SDK और पहुँच पहचानने में मदद करेगी। गुप्त जानकारी शामिल न करें।
शुरुआत करें
खाता सक्रिय होने के बाद अधिकृत प्रशासक आपके एकीकरण के लिए ज़रूरी अनुमतियों वाली कुंजी बनाता है।
यदि आपके परिवेश के लिए SDK पैकेज प्रकाशित किया गया है, तो उसे डेवलपर पोर्टल से डाउनलोड करें, उसका SHA-256 जाँचें और डाउनलोड की गई फ़ाइल स्थापित करें।
अपनी कुंजी को दी गई अनुमतियों के अनुसार स्टॉक, ऑर्डर और शिपमेंट पढ़ें।
वेबहुक
वेब ऐप में सब्सक्रिप्शन बनाएँ, ping भेजकर जाँचें और डिलीवरी के प्रयास देखें। आउटबॉक्स उन विफलताओं पर दोबारा प्रयास करता है जो पुनः प्रयास के योग्य हैं; सभी प्रयास समाप्त होने पर घटनाएँ डेड-लेटर कतार में दिखाई देती रहती हैं।
कार्यक्षेत्र
CSV या संरचित पंक्तियाँ आयात करें; अस्वीकृत पंक्तियों को जाँचें, सुधारें और दोबारा भेजें।
SKU का मिलान करें और मौजूद, आरक्षित तथा उपलब्ध स्टॉक पढ़ें।
आवक की योजनाएँ तैयार करें, पंक्तियाँ जोड़ें, डिलीवरी के समय-स्लॉट माँगें और प्राप्ति में अंतर पर नज़र रखें।
ऑर्डर पूर्ति की प्रक्रिया में शिपमेंट बनने के बाद वाहक, ट्रैकिंग और डिलीवरी की स्थिति पढ़ें।
ऑर्डर से जुड़ा मामला खोलें और तस्वीरें या दस्तावेज़ संलग्न करें।
अपने एकीकरण से सब्सक्रिप्शन और डिलीवरी का इतिहास पढ़ें।
भागीदार कुंजियाँ
कुंजियाँ अपने सर्वर पर रखें। खाते और भागीदार की अनुमतियाँ हर कार्रवाई का दायरा तय करती हैं; अधिकृत प्रशासक उपयुक्त पोर्टल में कुंजियाँ बनाते और बदलते हैं तथा वेबहुक सेट करते हैं।
अपने डेटा प्रवाह और ज़रूरी कार्रवाइयों का विवरण तैयार रखें। हम आपके एकीकरण के लिए खाते की पहुँच, अनुमतियों और SDK पैकेज की पुष्टि करेंगे।
Ysend की टीम आपके व्यवसाय के लिए सेवाएँ, कनेक्शन और लागू करने की योजना चुनने में मदद करती है।