Residential प्लान और कीमत

GET/account/api/v1/residential/catalog

प्राधिकरण

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
आवश्यक अनुमति	`read`
Accept	`application/json`

पैरामीटर

नाम	प्रकार	विवरण
`package_id` queryवैकल्पिक	`integer`	residential_packages की ARNPROXY पैकेज ID, प्रदाता का package_key नहीं।

अनुरोध उदाहरण

cURL

printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    'https://www.arnproxy.com/account/api/v1/residential/catalog'

इस पेज पर उदाहरण नहीं चलते। API कुंजी सर्वर की पर्यावरण चर में रखें, URL या ब्राउज़र कोड में नहीं। POST के लिए request.json तैयार करें।

उत्तर

200सफल उत्तर

application/json

{
    "ok": true,
    "data": {
        "product_id": 33,
        "currency": "TRY",
        "locations": [
            {
                "location_id": 20,
                "packages": [
                    {
                        "time_id": 201,
                        "name": "1 GB",
                        "gb": 1,
                        "days": 30,
                        "price": "15.00",
                        "price_minor": 1500
                    }
                ]
            }
        ],
        "purposes": [],
        "package_id": null,
        "purchase_available": true,
        "stock_checked": false,
        "provider_checked": false,
        "source": "website_residential_prices"
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}

उत्तर के फ़ील्ड और प्रकार

नाम	प्रकार	विवरण
`ok`	`boolean`	सफलता संकेत; false पर error.code देखें।
`data`	`object`	कार्रवाई-विशिष्ट परिणाम; उदाहरण कृत्रिम और समझाने के लिए हैं।
`data.product_id`	`integer`	स्थानीय कैटलॉग स्थान या उत्पाद प्रकार ID।
`data.currency`	`string`	खाते की लेनदेन मुद्रा: TRY या USD।
`data.locations`	`array`	locations का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.locations[]`	`object`	locations का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.locations[].location_id`	`integer`	स्थानीय कैटलॉग स्थान या उत्पाद प्रकार ID।
`data.locations[].packages`	`array`	packages का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.locations[].packages[]`	`object`	packages का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.locations[].packages[].time_id`	`integer`	स्थानीय अवधि/GB प्लान ID, दिनों या GB की गिनती नहीं।
`data.locations[].packages[].name`	`string`	name का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`data.locations[].packages[].gb`	`integer`	ट्रैफ़िक मात्रा; सूची/सेटिंग कार्रवाई ट्रैफ़िक नहीं खरीदती।
`data.locations[].packages[].days`	`integer`	प्लान अवधि दिनों में, GB प्लान की ट्रैफ़िक मात्रा से अलग।
`data.locations[].packages[].price`	`string`	धनराशि; शुद्धता के लिए लौटाया पाठ/पूर्णांक प्रारूप बनाए रखें।
`data.locations[].packages[].price_minor`	`integer`	लघुतम मुद्रा इकाई में पूर्णांक: 1000 = 10.00 TRY/USD।
`data.purposes`	`array`	पुराने प्रतिक्रिया स्वरूप की संगतता के लिए purposes खाली ऐरे रहता है; इसे ग्राहक के चयन के रूप में न दिखाएँ।
`data.package_id`	`integer\|null`	संबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
`data.purchase_available`	`boolean`	शर्तों/अनुमतियों के अनुसार उपलब्धता, स्टॉक या प्रदाता की गारंटी नहीं।
`data.stock_checked`	`boolean`	कीमत/स्थानीय परिणाम अकेले प्रदाता या स्टॉक की गारंटी नहीं।
`data.provider_checked`	`boolean`	कीमत/स्थानीय परिणाम अकेले प्रदाता या स्टॉक की गारंटी नहीं।
`data.source`	`string`	डेटा स्रोत; स्थानीय रिकॉर्ड और लाइव प्रदाता क्वेरी अलग प्रमाण हैं।
`meta`	`object`	अनुरोध संबद्धता और डेटा-स्रोत मेटाडेटा।
`meta.request_id`	`string`	इस HTTP अनुरोध की पहचान; कार्रवाई कुंजी या ऑर्डर ID नहीं।
`meta.phase`	`string`	phase का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
`meta.source`	`string`	डेटा स्रोत; स्थानीय रिकॉर्ड और लाइव प्रदाता क्वेरी अलग प्रमाण हैं।

त्रुटि उत्तर

HTTP 401 · INVALID_API_KEY

{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

प्रमाणीकरण और जाँच निष्पादन से पहले अनुरोध रोक सकते हैं। त्रुटि संदर्भ देखें और सहायता के लिए request_id रखें। कुंजी या पासवर्ड न भेजें। त्रुटियाँ और सीमाएँ →

व्यवहार और महत्वपूर्ण नोट

पैकेज/सूची ID ARNPROXY रिकॉर्ड ID हैं, प्रदाता कुंजियाँ नहीं। पुराना स्नैपशॉट पहुँच नहीं देता; ज़रूरत पर residential_package_refresh लें।
Residential ऑर्डर में ग्राहक को उपयोग का उद्देश्य नहीं चुनना होता। नए पैकेज के लिए सर्वर वेबसाइट खरीद जैसा ही निश्चित उद्देश्य अपने आप निर्धारित करता है; purpose_id, subpurpose_id या other_purpose न भेजें। ट्रैफ़िक जोड़ने पर मौजूदा पैकेज का उद्देश्य बना रहता है।
पुराने प्रतिक्रिया स्वरूप की संगतता के लिए purposes खाली ऐरे रहता है; इसे ग्राहक के चयन के रूप में न दिखाएँ।