ARNPROXY

अलग सत्र सूची बनाएँ

POST/account/api/v1/residential/sessions/create
कार्रवाई की स्पष्ट पुष्टि करें

यह कार्रवाई रिकॉर्ड, शेष राशि या सेवा सेटिंग बदल सकती है। पहले दायरा और नोट पढ़ें। परिणाम अनिश्चित हो तो नई कार्रवाई के बजाय उसी की स्थिति पूछें।

प्राधिकरण

AuthorizationBearer YOUR_ARNPROXY_API_KEY
आवश्यक अनुमतिresidential_management
Acceptapplication/json
Content-Typeapplication/json
Idempotency-Key16–100 अक्षर, अंक, _ या -। एक ही कार्रवाई के लिए मान सहेजकर दोबारा उपयोग करें।

पैरामीटर

नामप्रकारविवरण
Idempotency-Key
headerआवश्यक
string16–100 अक्षर/अंक/_/-। कार्रवाई और स्थिति में समान मान रखें; अलग बॉडी में पुनः उपयोग न करें।
package_id
bodyआवश्यक
integerresidential_packages की ARNPROXY पैकेज ID, प्रदाता का package_key नहीं।
expected_revision
bodyआवश्यक
stringइस कार्रवाई की दायरा/सेटिंग क्वेरी का revision: 64 छोटे हेक्स अक्षर।
terms
bodyआवश्यक
booleanस्पष्ट स्वीकृति के लिए JSON बूलियन true चाहिए, "true" स्ट्रिंग नहीं।

अनुरोध का मुख्य भाग

YOUR_/FROM_ को संबंधित कैटलॉग, कोट या दायरे के मान से बदलें। उदाहरणों में सहमति false है; वास्तविक कार्रवाई केवल जानबूझकर मंज़ूर करें।

request.json
{
    "package_id": "YOUR_PACKAGE_ID",
    "expected_revision": "FROM_SCOPE_REVISION",
    "terms": false
}

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

cURL
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    --header 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY' \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/residential/sessions/create'

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

उत्तर

200सफल उत्तर
application/json
{
    "ok": true,
    "data": {
        "state": "completed",
        "action": "create",
        "package_id": 20001,
        "list_id": 30002,
        "reason_code": null,
        "replayed": false,
        "credentials_included": false,
        "gb_purchased": 0,
        "balance_changes": 0,
        "package_expiry_changes": 0,
        "manual_review_required": false
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
उत्तर के फ़ील्ड और प्रकार
नामप्रकारविवरण
okbooleanसफलता संकेत; false पर error.code देखें।
dataobjectकार्रवाई-विशिष्ट परिणाम; उदाहरण कृत्रिम और समझाने के लिए हैं।
data.statestringरिकॉर्ड/कार्रवाई स्थिति। accepted डिलीवरी नहीं; completed कनेक्शन परीक्षण नहीं।
data.actionstringaction का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.package_idintegerसंबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
data.list_idintegerसंबंधित ARNPROXY रिकॉर्ड ID; आंतरिक प्रदाता ID के बदले इसे लें।
data.reason_codestring|nullनिश्चित कारण कोड या null, मूल प्रदाता त्रुटि पाठ नहीं।
data.replayedbooleanउसी कार्रवाई का सहेजा परिणाम लौटा, नए शुल्क/कार्रवाई का प्रमाण नहीं।
data.credentials_includedbooleanक्या परिणाम/कुंजी गोपनीय क्रेडेंशियल शामिल या अनुमति देता है।
data.gb_purchasedintegerट्रैफ़िक मात्रा; सूची/सेटिंग कार्रवाई ट्रैफ़िक नहीं खरीदती।
data.balance_changesintegerकार्रवाई का बताया प्रभाव; स्वचालित नवीनीकरण बाद में अलग शुल्क लगा सकता है।
data.package_expiry_changesintegerpackage expiry changes का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
data.manual_review_requiredbooleanmanual review required का कार्रवाई-विशिष्ट मान। लौटाया प्रकार बनाए रखें और व्यवहार नोट देखें।
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 ARNPROXY रिकॉर्ड ID हैं, प्रदाता कुंजियाँ नहीं। पुराना स्नैपशॉट पहुँच नहीं देता; ज़रूरत पर residential_package_refresh लें।
  • सत्र प्रत्यय के लिए अलग बनाई सत्यापित विशेष सूची चाहिए। TTL को 1–64 अक्षर/अंक session चाहिए; सकारात्मक s/m/h अधिकतम 24 घंटे। पाठ बनना कनेक्शन नहीं; वास्तविक उपयोग ट्रैफ़िक खर्च करता है।
  • टाइमआउट/5xx लिखने की विफलता का प्रमाण नहीं। मूल Idempotency-Key से स्थिति पूछें। नई कुंजी से न दोहराएँ; GET बदलाव फिर नहीं भेजता।
उसी कार्रवाई को ट्रैक करेंसूची कार्रवाई जाँचें →

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