मैसेजिंग पंजीकरण की विकल्प-सूचियाँ लोड करें

पंजीकरण फ़ॉर्म बनाने से पहले विकल्प लोड करें

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

एक विकल्प-सूची चुनें

TCR की प्रतिक्रिया सीधे संसाधित करें

प्रतिक्रिया का मुख्य भाग सीधे TCR API का होता है। कई पुराने /v3 एंडपॉइंट के विपरीत, इसमें अतिरिक्त status/response आवरण नहीं होता। इसे समझने से पहले HTTP स्थिति जाँचें। विकल्प-सूची में स्ट्रिंग लेबल या संरचित परिभाषाएँ हो सकती हैं, इसलिए यह न मानें कि हर मान में समान फ़ील्ड होंगे। यदि HTTP अनुरोध सफल हो, लेकिन मुख्य भाग अपेक्षित संरचना का मान्य JSON न हो, तो उसे चुपचाप खाली सूची से बदलने के बजाय बताएँ कि विकल्प प्राप्त नहीं हो सके।

विकल्प-सूची के विकल्पों को पात्रता और मूल्य निर्धारण से अलग रखें

उपयोग के मामलों की सामान्य सूची यह नहीं बताती कि कोई विशिष्ट ब्रांड किन उपयोग के मामलों के लिए पात्र है। वर्तमान पोर्टल अभियान बनाने से पहले ब्रांड की विशिष्ट पात्रता की जाँच करता है और चुने गए दूरसंचार सेवा प्रदाता की आवश्यकताओं को जाँचता है। इसी तरह, आपूर्तिकर्ता के शुल्क का मेटाडेटा खाते का अंतिम खुदरा मूल्य नहीं है। खाते पर लागू मूल्य और पंजीकरण की शर्तों की अलग से समीक्षा करें। विकल्प-सूची लोड करने से किसी ब्रांड, अभियान या मैसेजिंग नंबर को अनुमोदन नहीं मिलता।

अनुपलब्ध विकल्प-सूचियों की स्थिति सँभालें

यदि विकल्प प्राप्त करने का प्रयास विफल हो, तो ग्राहक द्वारा फ़ॉर्म में भरी गई जानकारी सुरक्षित रखें। त्रुटि दिखाएँ और Retry-After लौटाए जाने पर उसका पालन करें तथा पुनः प्रयासों के बीच प्रतीक्षा बढ़ाएँ। हर विकल्प-सूची को बार-बार लोड न करें और अनुरोध दर सीमा या संचार त्रुटि को खाली मान्य विकल्प-सूची न मानें। इस GET के लिए इडेम्पोटेंसी कुंजी आवश्यक नहीं है और इसे परिवर्तन अनुरोधों के इडेम्पोटेंसी भंडार से दोबारा नहीं चलाया जाता।

अनुरोध

अनुमत स्रोत आईपी पते से HTTPS के माध्यम से सक्षम API खाते का उपयोग करें। वर्तमान रूट खाते की प्रमाणीकरण नीति का समर्थन करता है, जिसमें Basic प्रमाणीकरण और सक्षम बेयरर API खाते शामिल हैं। प्रदाता के क्रेडेंशियल का उपयोग न करें।

पथ में समर्थित विकल्प-सूची का नाम देकर GET अनुरोध करें। लागू विकल्प-सूची फ़िल्टर क्वेरी स्ट्रिंग में भेजें। अनुरोध के मुख्य भाग की आवश्यकता नहीं है।

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

प्रतिक्रिया

यह TCR रूट रजिस्ट्री का मुख्य भाग उसकी HTTP स्थिति के साथ सीधे लौटाता है। यह पुराने v3 के status.code/status.msg/response आवरण का उपयोग नहीं करता। विकल्प-सूचियों की संरचनाएँ अलग-अलग होती हैं: कुछ मानों को विवरण वाले ऑब्जेक्ट से जोड़ती हैं, तो अन्य मानों को स्ट्रिंग से जोड़ती हैं। बाद में फ़ॉर्म जमा करते समय मशीन-पठनीय कुंजियाँ बनाए रखें। संक्षिप्त काल्पनिक usecase उदाहरण ऐसे मैप को दर्शाता है जिसके मान ऑब्जेक्ट हैं; यह वास्तविक समय की विकल्प-सूची या निश्चित रूप से पूर्ण स्कीमा नहीं है। HTTP स्थिति और अपेक्षित JSON संरचना, दोनों जाँचें।

प्रतिक्रिया की संरचना का उदाहरण; यह खाते का वास्तविक समय का डेटा या वर्तमान मूल्य प्रस्ताव नहीं है।

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

त्रुटियाँ

• 401: खाते का प्रमाणीकरण विफल हुआ। API क्रेडेंशियल, खाते की सक्षम स्थिति और लागू स्रोत आईपी प्रतिबंध जाँचें।
• 400/404 और रजिस्ट्री की अन्य त्रुटियाँ: विकल्प-सूची या फ़िल्टर अमान्य या अनुपलब्ध है। वर्तमान रूट अपस्ट्रीम की HTTP स्थिति और प्रतिक्रिया का मुख्य भाग जस का तस रखता है; कोई सार्वभौमिक v3 त्रुटि आवरण नहीं है।
• 429: खाते या साझा प्रदाता की अनुरोध सीमा पूरी हो गई है। Retry-After का पालन करें और बढ़ते प्रतीक्षा अंतराल के साथ पुनः प्रयास करें।
• 502: रजिस्ट्री से संपर्क नहीं हो सका। उपलब्धता अज्ञात है; सफल परिणाम के रूप में खाली विकल्प न लौटाएँ।
• 503: अनुरोध सीमित करने वाली प्रणाली या अपस्ट्रीम सेवा अनुपलब्ध है। पुनः प्रयास करने से पहले प्रतिक्रिया का मुख्य भाग और कोई भी Retry-After हेडर जाँचें।

उपलब्धता और अतिरिक्त प्रभाव

• समीक्षा किए गए पथ में यह विकल्प-सूची GET किसी ब्रांड या अभियान को नहीं बनाता, पंजीकरण जमा नहीं करता, संसाधन आरक्षित नहीं करता और पंजीकरण शुल्क नहीं लेता। यह प्रदाता से संपर्क करता है और अनुरोध के ऑडिट रिकॉर्ड लिखता है।
• विकल्प-सूची की परिभाषाएँ और आपूर्तिकर्ता के किसी भी शुल्क का मेटाडेटा ग्राहक के लिए खुदरा मूल्य प्रस्ताव नहीं हैं। वर्तमान पोर्टल अभियान के खुदरा मूल्य अलग से प्राप्त करता है; पुराने getCampaignPrice सहायक फ़ंक्शन और गणना-सूचियों की पुरानी मूल्य टिप्पणियों को इस रूट का मूल्य निर्धारण अनुबंध नहीं माना जाना चाहिए।
• विकल्प-सूची में किसी प्रविष्टि का समर्थित होना इस बात का प्रमाण नहीं है कि कोई विशिष्ट ब्रांड उस उपयोग के मामले के लिए पात्र है। बाद में पंजीकरण अनुरोध भेजने से पहले ब्रांड की विशिष्ट पात्रता जाँच, घोषणाएँ, सहमति और खाते के मूल्य निर्धारण की समीक्षा पूरी करें।