API और डेवलपर दस्तावेज़

एंडपॉइंट्स (Endpoints)

GET /api/my-ip

कॉल करने वाले के सार्वजनिक आईपी के लिए जियोलोकेशन और नेटवर्क डेटा लौटाता है, जैसा कि सर्वर द्वारा देखा गया है।

curl https://ipcheck.mubarokah.com/api/my-ip

GET /api/lookup?q=<ip|domain>

किसी भी IPv4, IPv6 या केवल डोमेन को खोजें। प्रोटोकॉल (http/https) और पाथ को अस्वीकार कर दिया जाता है।

curl "https://ipcheck.mubarokah.com/api/lookup?q=8.8.8.8"

POST /api/bulk

बैच खोज (प्रति अनुरोध 50 तक)। समवर्ती (concurrency) सर्वर-साइड पर सीमित है।

curl -X POST -H 'content-type: application/json' \
  -d '{"queries":["8.8.8.8","1.1.1.1","example.com"]}' \
  https://ipcheck.mubarokah.com/api/bulk

रिस्पांस का प्रारूप

{
  "ok": true,
  "query": "8.8.8.8",
  "ip": "8.8.8.8",
  "ipVersion": "IPv4",
  "location": {
    "continent": "North America",
    "country": "United States",
    "countryCode": "US",
    "regionName": "Virginia",
    "city": "Ashburn",
    "zip": "20149",
    "lat": 39.0438,
    "lon": -77.4874,
    "timezone": "America/New_York",
    "utcOffsetSeconds": -14400,
    "currency": "USD"
  },
  "network": {
    "isp": "Google LLC",
    "org": "Google Public DNS",
    "as": "AS15169 Google LLC",
    "asname": "GOOGLE",
    "reverse": "dns.google"
  },
  "flags": { "mobile": false, "proxy": false, "hosting": true }
}

त्रुटियाँ (Errors)

• invalid_query — इनपुट एक वैध आईपी या डोमेन नहीं है।
• rate_limited — अपस्ट्रीम प्रदाता दर सीमा तक पहुँच गया।
• provider_unreachable — अपस्ट्रीम सर्वर ऑफ़लाइन है।

दर सीमा और कैशिंग

प्रतिक्रियाओं को प्रति क्वेरी 10 मिनट के लिए सर्वर-साइड पर कैश किया जाता है। अपस्ट्रीम प्रदाता का मुफ्त सार्वजनिक स्तर दर-सीमित है और गैर-व्यावसायिक उपयोग के लिए है। उत्पादन ट्रैफ़िक के लिए हम नीचे दिए गए पर्यावरण चरों (environment variables) के माध्यम से एक वाणिज्यिक प्रदाता को कॉन्फ़िगर करने की सलाह देते हैं।

प्रदाता अमूर्तता (Abstraction)

सर्वर पर निम्नलिखित पर्यावरण चर सेट करें। संवेदनशील रहस्य कभी भी ब्राउज़र के सामने प्रकट नहीं होते हैं।

IP_PROVIDER=ip-api            # or ip-api-pro
IP_API_KEY=...                # required for pro
IP_API_BASE=http://ip-api.com

टिप्पणियां

• आईपी जियोलोकेशन एक अनुमान है, जो अधिक से अधिक शहर या महानगरीय स्तर तक सटीक होता है।
• निजी और आरक्षित आईपी श्रेणियों को जियोलोकेट नहीं किया जा सकता है।
• API कैशिंग के लिए आवश्यक जानकारी के अलावा क्वेरी सामग्री को लॉग नहीं करता है।