AlwaysCompleted API से इंटीग्रेशन बनाएँ

सेवाएँ लेने, ऑर्डर देने और उनकी प्रगति देखने के लिए AlwaysCompleted को अपने सर्वर की प्रक्रिया से जोड़ें। यह गाइड पहले केवल जानकारी पढ़ने वाले अनुरोध से लेकर ऑर्डर बनाने की ज़रूरी जाँचों तक ले जाती है। सभी पैरामीटर और जवाबों के उदाहरणों के लिए API रेफ़रेंस खुला रखें।

जोड़ने की तैयारी करें

1. खाता बनाएँ और अपने खाते की API key सर्वर की कॉन्फ़िगरेशन में इस्तेमाल करें।
2. जिन सेवाओं को देने की योजना है, उनकी शर्तें और सेवा कैटलॉग पढ़ें। ज़रूरतें, उपलब्ध विकल्प और ऑर्डर की सीमाएँ चुनी हुई सेवा पर निर्भर हैं।
3. अपने बैकएंड से HTTPS पर अनुरोध भेजें। सामान्य TLS प्रमाणपत्र सत्यापन चालू रखें।
4. API key अपने सर्वर पर सुरक्षित रखें। उसे सार्वजनिक पेज, ब्राउज़र JavaScript, स्क्रीनशॉट और साझा किए गए कोड उदाहरणों में शामिल न करें।

पहला केवल जानकारी पढ़ने वाला अनुरोध भेजें

दस्तावेज़ में दिया endpoint POST अनुरोध स्वीकार करता है और JSON लौटाता है। आधिकारिक अनुरोध उदाहरण URL-encoded फ़ॉर्म पैरामीटर इस्तेमाल करता है। हर action में आपकी API key और action का नाम शामिल होता है।

POST https://alwayscompleted.com/api/v2

key=YOUR_API_KEY&action=services

प्लेसहोल्डर केवल अपने सर्वर की कॉन्फ़िगरेशन में बदलें। services action कैटलॉग पढ़ता है; इससे ऑर्डर नहीं बनता। ऑर्डर फ़ॉर्म बनाने से पहले उसके जवाब से सेवा ID पहचानें और उपलब्ध फ़ील्ड देखें।

मौजूदा सेवा और खाते की जानकारी इस्तेमाल करें

सेवा सूची में हर सेवा का नाम, प्रकार, श्रेणी, दर, न्यूनतम और अधिकतम मात्रा तथा रीफ़िल और रद्दीकरण के संकेत मिलते हैं। चुनी हुई सेवा ID को उसके मौजूदा विवरण और ज़रूरतों से मिलाएँ। ऑर्डर बनाते समय दस्तावेज़ के उदाहरणों की ID या कीमतें कॉपी करने के बजाय लौटाए गए डेटा का इस्तेमाल करें।

खाते का बैलेंस और मुद्रा पढ़ने के लिए action=balance इस्तेमाल करें। रेफ़रेंस की उदाहरण राशियों को नमूना डेटा मानें। आपका ऐप वास्तविक जवाब दिखाए और आगे बढ़ने से पहले त्रुटियों को सँभाले।

कैश में रखे कैटलॉग के बदलाव सँभालें

कैश में रखा कैटलॉग अपडेट करते समय सहेजे विकल्प दोबारा उपलब्ध करने से पहले हटाई गई सेवा ID तथा बदली दरें या मात्रा सीमाएँ जाँचें। चुनी हुई ID मौजूदा जवाब में न हो तो मिलते-जुलते नाम वाली सेवा चुनने के बजाय उस ऑर्डर को समीक्षा के लिए रोकें। दर, प्रकार या मात्रा की सीमा बदले तो action=add भेजने से पहले फ़ॉर्म अपडेट करके चयन दोबारा जाँचें। जाँचे गए सेवा विवरण अपने स्थानीय ऑर्डर रिकॉर्ड के साथ रखें, ताकि बाद के सवाल ऐप द्वारा वास्तव में जाँचे गए चयन तक पहुँचा सकें।

सोच-समझकर ऑर्डर बनाएँ

ऑर्डर बनाने के लिए चुनी हुई सेवा ID और उस सेवा प्रकार के ज़रूरी फ़ील्ड के साथ action=add भेजें। Default ऑर्डर में link और quantity होते हैं; दूसरे प्रकारों के पैरामीटर अलग हैं। सबमिट करने से पहले रेफ़रेंस का संबंधित भाग देखें।

ऑर्डर सफलतापूर्वक बनने पर लौटाई गई ऑर्डर ID अपने रिकॉर्ड के साथ सहेजें। अनुरोध टाइमआउट हो या जवाब स्पष्ट न हो तो दोबारा भेजने से पहले परिणाम जाँचें। बिना जाँचे add अनुरोध दोहराने से अनचाहा डुप्लिकेट ऑर्डर बन सकता है। कनेक्शन की स्वचालित जाँच के लिए कभी ऑर्डर न बनाएँ।

ऑर्डर और उपलब्ध अगले अनुरोधों की निगरानी करें

एक ऑर्डर के लिए order के साथ action=status इस्तेमाल करें, या अधिकतम 100 के बैच के लिए अल्पविराम से अलग ID के साथ orders दें। दस्तावेज़ वाले जवाब में status, charge, start_count, remains और currency शामिल हैं। हर परिणाम जाँचें: बैच में किसी एक ID के लिए त्रुटि हो सकती है।

रीफ़िल और रद्दीकरण उपलब्धता तथा चुनी हुई सेवा की शर्तों के अधीन अनुरोध हैं। रीफ़िल माँगने के लिए action=refill, उसकी प्रगति के लिए action=refill_status और रद्दीकरण माँगने के लिए action=cancel इस्तेमाल करें। दस्तावेज़ में दिए बैच विकल्प अधिकतम 100 ID स्वीकार करते हैं। अनुरोध भेजने से रीफ़िल या रद्दीकरण की मंज़ूरी की गारंटी नहीं मिलती।

अपना इंटीग्रेशन आगे बढ़ाएँ

सटीक action पैरामीटर और उदाहरणों के लिए पूरी API रेफ़रेंस देखें। ग्राहक के लिए सेवा ऑर्डर प्रक्रिया बना रहे हैं तो रीसेलर के लिए AlwaysCompleted पढ़ें। ग्राहक के ऑर्डर स्वीकार करने से पहले हर सेवा के विवरण के साथ शर्तें और नीतियाँ पढ़ें।