help-icon
icon

Public API उपयोग गाइड

helpDetails-time-icon2026-09-23T15:37:56+08:00

व्यक्तिगत API Key से फ़ोन, प्रॉक्सी, ऐप सूची और रीसेट, मौजूदा प्रॉक्सी जोड़ना व इंस्टॉलेशन करें। छह ग्राहक endpoint https://api.foxphone.com और /public_api/v1 पर हैं।

Endpoint

HTTP/public_api/v1विवरण
GET/phonesफ़ोन सूची
GET/proxiesप्रॉक्सी सूची
POST/phones/actions/resetबैच रीसेट
POST/proxies/{proxy_id}/bindमौजूदा प्रॉक्सी जोड़ें
GET/appsऐप और संस्करण
POST/phones/actions/install-appबैच इंस्टॉलेशन

API Key तैयार करें

अवतार से Settings और व्यक्तिगत केंद्र में API Key खोलें। प्रति खाते एक सक्रिय Key है। दोबारा बनाने पर पुरानी तुरंत अमान्य, पूरा मान केवल एक बार दिखता है। हर अनुरोध में X-API-Key और POST में Content-Type: application/json दें। वेब JWT, Cookie, Device-ID, hash, platform नहीं चाहिए; Bearer इसका विकल्प नहीं।

X-API-Key: <your_api_key>

Key केवल सर्वर environment या secret manager में रखें, frontend, सार्वजनिक repository या client में नहीं। URL, body, log, ticket में न रखें। उदाहरण API_KEY उपयोग करते हैं। लीक पर तुरंत बदलें/बंद करें और सभी callers अपडेट करें।

export API_KEY="<your_api_key>"

नियम और प्रतिक्रिया

HTTPS प्रयोग करें। सफलता HTTP 200 और data में payload; त्रुटि 4xx/5xx और string reason। केवल message नहीं, स्थिति, reason और प्रत्येक परिणाम जाँचें। त्रुटि data null हो सकता है; request_id रखें। भागीदार /open_api/v1 अलग प्रमाण प्रणाली है।

एक Key पर सभी अनुरोध 60 प्रति मिनट साझा करते हैं। page_num/page_size अनुपस्थित या गैरधनात्मक हों तो 1/20; page_size>100 पर 400। फ़ोन/प्रॉक्सी में search, ऐप में app_name। pod_ids string array में सफाई, खाली और डुप्लिकेट हटाने के बाद 1–100 मान चाहिए। परिणाम pod_id से मिलाएँ।

pod_id हमेशा string है। proxy_id, total, संस्करण id और version_code JSON संख्याएँ हैं; विशेषकर JavaScript में बड़े पूर्णांक बिना हानि पढ़ें। 0 और खाली string बने रहते हैं; खाली सूची [] या null हो सकती है।

{
  "request_id": "example-request-id",
  "code": 200,
  "data": {
    "total": 0,
    "phones": []
  },
  "message": "success"
}

फ़ोन सूची

खाते के फ़ोन सूचीबद्ध, search नाम या pod_id से। data.phones में pod_id, name, online_status, operating_status, proxy_id; data.total संख्या। proxy_id=0 मतलब संबद्ध नहीं। स्थानीय संबद्धता क्लाउड में पूरा होने का प्रमाण नहीं।

online_status: 0 शुरू, 1 चालू, 2 बंद, 3 बंद हो रहा, 4 रीस्टार्ट, 5 स्ट्रीमिंग, 6 स्ट्रीम तैयार। operating_status: 0 शुरू, 1 चालू, 2 बंद, 3 बंद हो रहा, 4 रीस्टार्ट, 5 रीसेट; 6 अपरिभाषित। दोनों अलग हैं।

फ़ील्डप्रकार
pod_idstring
namestring
online_statusinteger
operating_statusinteger
proxy_idnumber
curl --fail-with-body "https://api.foxphone.com/public_api/v1/phones?page_num=1&page_size=20&search=example" \
  -H "X-API-Key: ${API_KEY}"
{
  "request_id": "example-request-id",
  "code": 200,
  "data": {
    "total": 1,
    "phones": [
      {
        "pod_id": "pod-example-001",
        "name": "test-phone",
        "online_status": 1,
        "operating_status": 1,
        "proxy_id": 42
      }
    ]
  },
  "message": "success"
}

प्रॉक्सी सूची

प्रॉक्सी नाम/ID से खोजें। data.proxies में proxy_id, name, proxy_type, proxy_ip, proxy_port, check_status। पोर्ट string है; प्रमाण और refresh URL नहीं लौटते। स्थिति unchecked, success, failed; पुराना डेटा खाली हो सकता है। पुराना सफल परीक्षण वर्तमान उपलब्धता की गारंटी नहीं।

curl --fail-with-body "https://api.foxphone.com/public_api/v1/proxies?page_num=1&page_size=20&search=example" \
  -H "X-API-Key: ${API_KEY}"
{
  "request_id": "example-request-id",
  "code": 200,
  "data": {
    "total": 1,
    "proxies": [
      {
        "proxy_id": 42,
        "name": "example-proxy",
        "proxy_type": "socks5",
        "proxy_ip": "203.0.113.42",
        "proxy_port": "1080",
        "check_status": "success"
      }
    ]
  },
  "message": "success"
}

बैच रीसेट

रीसेट डेटा मिटाता है: पहले बैकअप व लक्ष्य जाँचें। केवल pod_ids दें; फ़ोन चालू, उपलब्ध और अपने होने चाहिए। बंद, रीसेट या टकराव वाले अस्वीकृत। phone_template_mode में 0 और phone_template_id में खाली भी 400 / PHONE_TEMPLATE_PARAMETER_NOT_SUPPORTED देते हैं। मॉडल यादृच्छिक; विकल्प न हो तो template नहीं। सिमुलेशन रखा जाता है, पुराना प्रॉक्सी जाँचकर बहाल करने का प्रयास; नया प्रॉक्सी चुना या खरीदा नहीं जाता।

curl --fail-with-body "https://api.foxphone.com/public_api/v1/phones/actions/reset" \
  -H "X-API-Key: ${API_KEY}" \
  -H "Content-Type: application/json" \
  --data '{"pod_ids":["pod-example-001"]}'

मौजूदा प्रॉक्सी जोड़ें

पथ में सूची का धनात्मक proxy_id, body में केवल pod_ids। संसाधन अपने, प्रॉक्सी वैध, समयबद्ध और नई जाँच सफल होना चाहिए। बंद फ़ोन सेटिंग रखकर बंद रहता है, बाद के स्टार्ट पर लागू। चालू फ़ोन पर असमकालिक लागू, रीस्टार्ट हो सकता है। टकराव अस्वीकृत; अमान्य प्रॉक्सी 409 / BATCH_PRECHECK_FAILED और item PRECHECK_FAILED।

curl --fail-with-body "https://api.foxphone.com/public_api/v1/proxies/42/bind" \
  -H "X-API-Key: ${API_KEY}" \
  -H "Content-Type: application/json" \
  --data '{"pod_ids":["pod-example-001"]}'

बैच परिणाम और त्रुटि

केवल रीसेट/बाइंड में successful_pod_ids/failed_items। पूरे बैच की जाँच विफल: 409 में data.failed_items, ऊपर metadata नहीं। आंशिक स्वीकृति संभव, सिस्टम पार rollback नहीं। सफल सूची केवल स्वीकार/सहेजना, पूरा होना नहीं; null हो सकती है। पूरा बैच न दोहराएँ।

{
  "request_id": "example-request-id",
  "code": 200,
  "data": {
    "successful_pod_ids": [
      "pod-example-001"
    ],
    "failed_items": [
      {
        "pod_id": "pod-example-002",
        "code": "PROVIDER_REJECTED",
        "message": "provider rejected the operation"
      }
    ]
  },
  "message": "success"
}
{
  "request_id": "example-request-id",
  "code": 409,
  "data": {
    "failed_items": [
      {
        "pod_id": "pod-example-002",
        "code": "PHONE_NOT_RUNNING",
        "message": "phone is not running"
      }
    ]
  },
  "message": "batch precheck failed",
  "reason": "BATCH_PRECHECK_FAILED"
}
फ़ील्डविवरण
RESOURCE_NOT_OWNEDसंसाधन वर्तमान खाते का नहीं है
RESET_IN_PROGRESSफ़ोन रीसेट जारी है
OPERATION_IN_PROGRESSटकराव वाला ऑपरेशन जारी है
PHONE_NOT_RUNNINGफ़ोन चालू नहीं है
RESOURCE_UNAVAILABLEसंसाधन मौजूद नहीं या उपलब्ध नहीं है
PRECHECK_FAILEDप्रॉक्सी या अन्य पूर्व जाँच विफल हुई
PROVIDER_REJECTEDक्लाउड प्रदाता ने अनुरोध अस्वीकार किया या भेजना विफल हुआ

ऐप और संस्करण

सूची में source आवश्यक: official या user। app_name, वैकल्पिक integer app_type और सामान्य pagination। package_name से समूह, total ऐप गिनता है। पैकेज आरोही, versions version_code से अवरोही। इंस्टॉल में package_name/version_code दें, version_id/version_name नहीं। यह फ़ोन के इंस्टॉल ऐप नहीं हैं।

curl --fail-with-body "https://api.foxphone.com/public_api/v1/apps?source=official&page_num=1&page_size=20&app_name=example" \
  -H "X-API-Key: ${API_KEY}"
{
  "request_id": "example-request-id",
  "code": 200,
  "data": {
    "total": 1,
    "apps": [
      {
        "app_id": "app-example",
        "app_name": "Example App",
        "package_name": "com.example.app",
        "app_type": 1,
        "icon_url": "",
        "source": "official",
        "versions": [
          {
            "id": 101,
            "version_id": "version-example",
            "version_name": "1.0.0",
            "version_code": 100
          }
        ]
      }
    ]
  },
  "message": "success"
}

बैच इंस्टॉलेशन

गैरखाली package_name, धनात्मक integer version_code और वैध pod_ids चाहिए; अपने चालू फ़ोन चुनें। source स्पष्ट दें। अनुपस्थित/खाली पहले व्यक्तिगत फिर आधिकारिक खोजता है; स्पष्ट source में fallback नहीं। APK URL नहीं। data.items का pod_id/job_id केवल जमा होना है। इंस्टॉल परिणाम endpoint या रीसेट/बाइंड जैसी batch स्थिति जाँच प्रतिक्रिया नहीं।

curl --fail-with-body "https://api.foxphone.com/public_api/v1/phones/actions/install-app" \
  -H "X-API-Key: ${API_KEY}" \
  -H "Content-Type: application/json" \
  --data '{"source":"official","package_name":"com.example.app","version_code":100,"pod_ids":["pod-example-001"]}'
{
  "request_id": "example-request-id",
  "code": 200,
  "data": {
    "items": [
      {
        "pod_id": "pod-example-001",
        "job_id": "job-example-001"
      }
    ]
  },
  "message": "success"
}

त्रुटि और पुनः प्रयास

400 में parameter सुधारें; 401/403 Key/खाता; 409 टकराव; 429 backoff। query कोटा में दोहराएँ। write का सार्वजनिक idempotency key नहीं: timeout/500 के बाद पहले स्वीकृति जाँचें। ऐप न मिलना, गलत संस्करण या जमा त्रुटि भी 500 / PUBLIC_API_INTERNAL_ERROR हो सकते हैं; यह न चलने का प्रमाण नहीं।

HTTPreason
400INVALID_ARGUMENT
400PHONE_TEMPLATE_PARAMETER_NOT_SUPPORTED
401INVALID_API_KEY
403API_KEY_DISABLED
403USER_ACCOUNT_UNAVAILABLE
409BATCH_PRECHECK_FAILED
429RATE_LIMIT_EXCEEDED
500PUBLIC_API_INTERNAL_ERROR
500PUBLIC_API_AUTH_ERROR

API Key सुरक्षा

Key केवल सर्वर environment या secret manager में रखें, frontend, सार्वजनिक repository या client में नहीं। URL, body, log, ticket में न रखें। उदाहरण API_KEY उपयोग करते हैं। लीक पर तुरंत बदलें/बंद करें और सभी callers अपडेट करें।

सत्यापन और सहायता

सहायता को request_id, path, HTTP, reason, समय और छिपाए parameter दें, Key नहीं। पहले read query, फिर अधिकृत परीक्षण फ़ोन पर write करें; बैच बढ़ाने से पहले परिणाम जाँचें।

संबंधित लेख

Email contact
Cookie notification iconकुकी सूचना
यह वेबसाइट उपयोगकर्ता अनुभव को बेहतर बनाने के लिए कुकीज़ का उपयोग करती है। हमारी कुकी नीति के बारे में अधिक जानने या अपनी सहमति वापस लेने के लिए, कृपया हमारी गोपनीयता नीति और कुकी नीति देखें।