ARNPROXY

स्थान और अवधि

GET/account/api/v1/catalog

प्राधिकरण

AuthorizationBearer YOUR_ARNPROXY_API_KEY
आवश्यक अनुमतिread
Acceptapplication/json

पैरामीटर

नामप्रकारविवरण
product_id
queryआवश्यक
integerproducts से उत्पाद ID; 1–2147483647।

अतिरिक्त उपयोग उदाहरण

ID और कीमतें उदाहरण मात्र हैं; कैटलॉग और उसी कोट के वास्तविक मान उपयोग करें। JSON ID और expected_total_minor संख्याएँ हों। सुरक्षा के लिए उदाहरणों में terms=false है; वास्तविक भुगतान वाले कार्य के लिए ग्राहक की स्पष्ट सहमति के बाद ही terms=true भेजें।

उपयोग का उद्देश्य: केवल उप-उद्देश्य चुनें

सामान्य ऑर्डर में ग्राहक से दो विकल्प न चुनवाएँ। catalog.purposes में id=201 खोजें और केवल उसके children दिखाएँ। purchase में purpose_id निश्चित पूर्णांक 201 है और subpurpose_id चुने गए उप-विकल्प की ID है। पुराने एकीकरणों के साथ संगतता के लिए कैटलॉग का पदानुक्रम बना हुआ है।

Node.js / JavaScript
const response = await fetch(
  'https://www.arnproxy.com/account/api/v1/catalog?product_id=' + productId,
  { headers: { Authorization: 'Bearer ' + apiKey } }
);
const catalog = await response.json();
if (!response.ok || !catalog.ok) throw new Error('Catalog request failed');
const purposeGroup = catalog.data.purposes.find(group => group.id === 201);
if (!purposeGroup) throw new Error('Purpose group 201 is not available');
const purposeOptions = purposeGroup.children.map(({ id, name }) => ({ id, name }));
// Show only purposeOptions. The customer selects selectedSubpurposeId.
const purchaseLine = {
  location_id: selectedLocationId,
  time_id: selectedTimeId,
  quantity: selectedQuantity,
  purpose_id: 201,
  subpurpose_id: selectedSubpurposeId
};
// Add other_purpose (1–30 characters) only when selectedSubpurposeId === -1.
// No purchase is sent by this example.

उपयोग का उद्देश्य: केवल उप-उद्देश्य चुनें

सामान्य ऑर्डर में ग्राहक से दो विकल्प न चुनवाएँ। catalog.purposes में id=201 खोजें और केवल उसके children दिखाएँ। purchase में purpose_id निश्चित पूर्णांक 201 है और subpurpose_id चुने गए उप-विकल्प की ID है। पुराने एकीकरणों के साथ संगतता के लिए कैटलॉग का पदानुक्रम बना हुआ है।

Python
import json
import urllib.request

request = urllib.request.Request(
    'https://www.arnproxy.com/account/api/v1/catalog?product_id=' + str(product_id),
    headers={'Authorization': 'Bearer ' + api_key}
)
with urllib.request.urlopen(request, timeout=20) as response:
    catalog = json.load(response)
if not catalog.get('ok'):
    raise RuntimeError('Catalog request failed')
purpose_group = next((g for g in catalog['data']['purposes'] if g['id'] == 201), None)
if purpose_group is None:
    raise RuntimeError('Purpose group 201 is not available')
purpose_options = [{'id': p['id'], 'name': p['name']} for p in purpose_group['children']]
# Display only purpose_options; the customer selects selected_subpurpose_id.
purchase_line = {
    'location_id': selected_location_id,
    'time_id': selected_time_id,
    'quantity': selected_quantity,
    'purpose_id': 201,
    'subpurpose_id': selected_subpurpose_id,
}
# For Other (-1), also set other_purpose to 1–30 characters.
# This example does not submit a purchase.

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

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/catalog?product_id=FROM_PRODUCTS'

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

उत्तर

200सफल उत्तर
application/json
{
    "ok": true,
    "data": {
        "product": {
            "id": 5,
            "name": "IPv4 Proxy",
            "minimum_quantity": 1
        },
        "currency": "TRY",
        "locations": [
            {
                "id": 10,
                "name": "Example country",
                "periods": [
                    {
                        "id": 101,
                        "name": "7 days",
                        "days": 7,
                        "base_unit_price": "10.0000"
                    }
                ]
            }
        ],
        "purposes": [
            {
                "id": 201,
                "name": "Purpose",
                "children": [
                    {
                        "id": 202,
                        "name": "Example purpose"
                    }
                ]
            }
        ],
        "discount_scope": "country",
        "stock_checked": false,
        "purchase_available": true
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
उत्तर के फ़ील्ड और प्रकार
नामप्रकारविवरण
okbooleanसफलता संकेत; false पर error.code देखें।
dataobjectकार्रवाई-विशिष्ट परिणाम; उदाहरण कृत्रिम और समझाने के लिए हैं।
data.productobjectproduct का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.product.idintegerसंबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
data.product.namestringname का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.product.minimum_quantityintegerइस उत्पाद की प्रति ऑर्डर पंक्ति न्यूनतम मात्रा।
data.currencystringखाते की लेनदेन मुद्रा: TRY या USD।
data.locationsarraylocations का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.locations[]objectlocations का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.locations[].idintegerसंबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
data.locations[].namestringname का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.locations[].periodsarrayperiods का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.locations[].periods[]objectperiods का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.locations[].periods[].idintegerसंबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
data.locations[].periods[].namestringname का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.locations[].periods[].daysintegerप्लान अवधि दिनों में, GB प्लान की ट्रैफ़िक मात्रा से अलग।
data.locations[].periods[].base_unit_pricestringbase unit price का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.purposesarraypurposes का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.purposes[]objectpurposes का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.purposes[].idintegerसंबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
data.purposes[].namestringname का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.purposes[].childrenarraychildren का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.purposes[].children[]objectchildren का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.purposes[].children[].idintegerसंबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
data.purposes[].children[].namestringname का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.discount_scopestringdiscount scope का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.stock_checkedbooleanकीमत/स्थानीय परिणाम अकेले प्रदाता या स्टॉक की गारंटी नहीं।
data.purchase_availablebooleanशर्तों/अनुमतियों के अनुसार उपलब्धता, स्टॉक या प्रदाता की गारंटी नहीं।
metaobjectअनुरोध संबद्धता और डेटा-स्रोत मेटाडेटा।
meta.request_idstringइस HTTP अनुरोध की पहचान; कार्रवाई कुंजी या ऑर्डर ID नहीं।
meta.phasestringphase का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
meta.sourcestringडेटा स्रोत; स्थानीय रिकॉर्ड और लाइव प्रदाता क्वेरी अलग प्रमाण हैं।

त्रुटि उत्तर

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

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

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

  • ID products/catalog से लें। quote पंक्ति में केवल location_id, time_id, quantity। purchase में purpose_id=201 और चुना subpurpose_id भी आवश्यक।
  • सामान्य ऑर्डर में ग्राहक से दो विकल्प न चुनवाएँ। catalog.purposes में id=201 खोजें और केवल उसके children दिखाएँ। purchase में purpose_id निश्चित पूर्णांक 201 है और subpurpose_id चुने गए उप-विकल्प की ID है। पुराने एकीकरणों के साथ संगतता के लिए कैटलॉग का पदानुक्रम बना हुआ है।
  • अन्य चुनने पर subpurpose_id=-1 और 1–30 अक्षरों का other_purpose भेजें। दूसरे विकल्पों में other_purpose आवश्यक नहीं है। purpose_id फिर भी 201 रहता है।

वर्तमान भाषा में खोजें। बंद करें: Esc