डेवलपर

GET/v3/get_proof_types

प्रमाण की श्रेणियों की सूची देखें

पहचान या पते के प्रमाण तैयार करने से पहले प्रमाण की श्रेणियों के पहचानकर्ता और इकाई के प्रकार खोजें।

इस पृष्ठ पर
  1. प्रमाण की श्रेणी चुनें
  2. वास्तविक आवश्यकताओं के अनुरूप प्रमाण चुनें
  3. अनुरोध
  4. उत्तर
  5. त्रुटियाँ
  6. उपलब्धता और अन्य प्रभाव

प्रमाण की श्रेणी चुनें

किसी पहचान के लिए आवश्यक प्रमाण तैयार करते समय उत्तर में मिली श्रेणी और इकाई के प्रकार का उपयोग करें। यह सूची श्रेणियों का विवरण देती है; यह आपकी अपलोड की गई फ़ाइलों की सूची नहीं है और किसी भी प्रमाण की स्वीकृति नहीं दर्शाती।

वास्तविक आवश्यकताओं के अनुरूप प्रमाण चुनें

किसी श्रेणी का सूची में होना यह नहीं दर्शाता कि वह हर देश, नंबर के प्रकार या ग्राहक की पहचान से जुड़ी आवश्यकताओं को पूरा करती है। प्रमाण अपलोड करने से पहले लागू आवश्यकताएँ पढ़ें और उत्तर में मिले पहचानकर्ताओं की आंतरिक संरचना या अर्थ का अनुमान न लगाएँ।

अनुरोध

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

URL पथ में दस्तावेज़ में दिए गए किसी भी पैरामीटर के साथ GET का उपयोग करें।

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_proof_types"

उत्तर

HTTP स्थिति के साथ-साथ JSON बॉडी में status.code भी जाँचें। response ऑब्जेक्ट की एक सरणी है, जिनमें id, name और entity_type फ़ील्ड होते हैं। ये मान प्रमाणों की वर्तमान सूची से आते हैं। पहचानकर्ताओं की आंतरिक संरचना या अर्थ का अनुमान न लगाएँ; नया पहचानकर्ता बनाने या हैश से निकालने के बजाय मिले हुए पहचानकर्ताओं को कॉपी करें। खाली सूची भी सफलतापूर्वक लौटाई जा सकती है। इस उदाहरण के आधार पर इकाई के प्रकारों की पूरी गणना-सूची को कोड में स्थिर रूप से न लिखें।

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "PROOF_TYPE_ID_FROM_RESPONSE",
      "name": "Example proof category",
      "entity_type": "ENTITY_TYPE_FROM_RESPONSE"
    }
  ]
}

त्रुटियाँ

  • प्रमाणीकरण या सेवा संबंधी त्रुटियों के लिए status.code और status.msg जाँचें। सफल उत्तर में खाली सूची मिलने का अर्थ किसी दस्तावेज़ की स्वीकृति या पंजीकरण से छूट नहीं है।

उपलब्धता और अन्य प्रभाव

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