प्रोडक्शन API के लिए सादे डॉक्स।
एंडपॉइंट जिन्हें आप कॉपी-पेस्ट कर सकते हैं। केवल कुंजी से प्रमाणीकरण — कोई OAuth झंझट नहीं। कुंजी मिलते ही डैशबोर्ड के अंदर इंटरैक्टिव OpenAPI ब्राउज़र।
प्रमाणीकरण
हर अनुरोध में एक ही key फील्ड होता है। डैशबोर्ड में एक बनाएं, कभी भी रोटेट करें। जब तक आप सेट न करें कोई समाप्ति नहीं।
रेट लिमिट
रीड एंडपॉइंट पर 60 अनुरोध/मिनट, राइट पर 30 अनुरोध/मिनट। प्लैटिनम टियर के ऊपर ये दोगुने हो जाते हैं — ऊंची सीमा के लिए सपोर्ट को संदेश करें।
/api/v2action =servicesवर्तमान दरों, न्यूनतम/अधिकतम, और रिफिल नीति के साथ उपलब्ध सेवाएं सूचीबद्ध करें।
/api/v2action =addएक ऑर्डर बनाएं। v3 पर Idempotency-Key हेडर समर्थित।
/api/v2action =statusलाइव स्थिति, प्रारंभिक गिनती, डिलीवर गिनती, शेष, ETA।
/api/v2action =refillपात्र सब्सक्राइबर ऑर्डर पर 90-दिन विंडो के भीतर मुफ्त रिफिल का अनुरोध करें।
वेबहुक, एक पैराग्राफ में।
डैशबोर्ड में एक URL कॉन्फ़िगर करें। हम स्थिति बदलाव पर एक JSON बॉडी POST करते हैं:in_progress,completed,partial,canceled. HMAC-SHA256 से साइन किया गया। अगर आपका एंडपॉइंट 5xx देता है तो हम 24h तक एक्सपोनेंशियल बैकऑफ के साथ पुनः प्रयास करते हैं।
OpenAPI ब्राउज़र डैशबोर्ड में रहता है।
पूर्ण स्पेक, अपनी कुंजी के विरुद्ध "Try it out", हर एंडपॉइंट के लिए अनुरोध/प्रतिक्रिया उदाहरण। इसे देखने के लिए साइन इन करें।
स्पेक खोलें