SMS वेरिफिकेशन API

1. GET /api/v2/tn101/get-services — कैटलॉग, उस आइडेंटिफ़ायर के साथ जिससे आप ऑर्डर करेंगे, और उसकी मौजूदा कीमत।
2. POST /api/v2/tn101/request-number — एक नंबर ऑर्डर करें। यह service_key लेता है, साथ में वैकल्पिक state और एरिया कोड। जवाब में ऑर्डर id, नंबर और उसकी एक्सपायरी का समय आता है।
3. GET /api/v2/tn101/get-number-details — order_id के साथ इसे पोल करें। कोड आने तक pin null रहता है और उसके बाद उसमें कोड होता है। यह API की सबसे सस्ती रीड है और लूप में कॉल करने के लिए ही बनी है।
4. POST /api/v2/tn101/reject-number — जिस नंबर पर कुछ नहीं आया, उसे रिलीज़ करें। चार्ज भी इसी से वापस आता है।

इस रास्ते पर आपको कुछ भी पुश नहीं किया जाता, इसलिए तीसरा कदम पोलिंग है। अगर आप पूछने के बजाय सूचना पाना चाहते हैं, तो अकाउंट ऑर्डर इवेंट्स पर webhooks भी भेजता है, जिन्हें पैनल में सेट किया जाता है।

हर रिक्वेस्ट में Authorization: Bearer <token> होता है। टोकन पैनल में API एक्सेस के तहत बनाए जाते हैं और वहीं कभी भी बदले जा सकते हैं — बदलते ही पुराना टोकन तुरंत अमान्य हो जाता है, इसलिए पहले अपनी कॉन्फ़िगरेशन में नया टोकन डाल लें।

बिना वैध टोकन वाली रिक्वेस्ट को 401 मिलता है। सस्पेंड अकाउंट, या जिसका API एक्सेस बंद है, उसे 403 मिलता है। जब पूरी साइट पर API बंद हो, तो हर एंडपॉइंट दिखावा करने के बजाय 503 लौटाता है।

हर एंडपॉइंट इन्हीं तीन फ़ील्ड के साथ जवाब देता है:

data में असली डेटा होता है, success वह boolean है जिस पर आप ब्रांच करते हैं, और summery इंसान के पढ़ने लायक मैसेज है। यह स्पेलिंग इस पेज की टाइपो नहीं है — API शुरू से यही फ़ील्ड नाम भेजता आया है, यह इसके ख़िलाफ़ लिखे हर इंटीग्रेशन में है, और एक अक्षर ठीक करने के लिए इसका नाम बदलना उन सबको तोड़ देगा। summery ही पढ़ें।

वैलिडेशन फ़ेल होने पर 422 आता है और data एक ऑब्जेक्ट होता है जिसमें फ़ील्ड नामों के सामने एरर मैसेज होते हैं, ताकि कॉल करने वाला बता सके कि कौन-सा आर्ग्युमेंट गलत था, न कि बस इतना कि कुछ गलत था।

API किसी साइनअप या पासवर्ड-रीसेट फ़्लो को मॉक के बजाय असली कैरियर पाथ पर चलाकर देखने का व्यावहारिक तरीका है — नंबर ऑर्डर करें, उससे अपना फ़ॉर्म भरें, कोड के लिए पोल करें, और फिर जाँचें कि आपका ऐप्लिकेशन आगे क्या करता है। यह स्टब से धीमा टेस्ट है, पर यह वे चीज़ें पकड़ता है जो स्टब नहीं पकड़ सकता: नॉर्मलाइज़ेशन, लाइन-टाइप फ़िल्टरिंग, और डिलीवरी की वे देरियाँ जिनका सामना आपके यूज़र्स को सच में करना पड़ेगा।

API पर प्रति सेकंड रिक्वेस्ट की कोई सीमा नहीं है, लेकिन ऑर्डर करने पर दो कोटा हैं, और ये वही हैं जो पैनल लागू करता है:

• खुले ऑर्डर। एक अकाउंट एक समय में सीमित संख्या में ही रिज़र्व्ड नंबर रख सकता है। एक साथ बहुत सारे खोलने के बजाय पोल करें और रिलीज़ करें।
• रोज़ाना कैंसल और एक्सपायर हुए ऑर्डर। रोज़ की सीमा पार करने पर ऑर्डर कुछ देर के लिए रुक जाते हैं, और बार-बार ऐसा होने पर यह रोक लंबी होती जाती है। हर रिज़र्वेशन असली सप्लाई खर्च करता है, कोड आए या नहीं — यह कोटा इसी की रक्षा करता है।

दोनों का विस्तार टेम्पररी नंबर पेज पर है, जहाँ बताया गया है कि ऑर्डर कैसे चलता है।