راهنمای استفاده از سایت


استفاده از API های ارائه شده در این سایت بسیار ساده است. پس از عضویت در سایت و ورود به حساب کاربری خود این مراحل را طی نمایید :

  1. وارد بخش مدیریت نرم افزارها شده و یک پلن دلخواه را برای نرم افزار خود فعال نمایید.
  2. با فعال سازی هر نرم افزار و پلن، یک کلید API به شما ارائه خواهد شد.
  3. نرم افزار شما از هر نوع (وب سایت، اپلیکیشن موبایل و ...) می باید در هنگام مراجعه و یا ورود کاربر، IP اینترنتی وی را شناسایی نماید. دقت نمایید که ممکن است کاربر در حال استفاده از یک پراکسی و یا مواردی نظیر آن باشد. در چنین شرایطی می باید تا حد امکان به IP واقعی کاربر دست پیدا کرد. مبنی کار API این سایت، IP ارسال شده از سوی شما خواهد بود.
  4. درخواست خود را به فرمت زیر برای ip2info ارسال کنید.
    https://ip2info.ir/api/{your_api_key}/{user_ip}
    در الگوی فوق، 2 قسمت متغیر وجود دارند که به شرح آنها می پردازیم :
    • api_key : کلیدی است که در مرحله شماره 2 به آن اشاره شد. دقت نمایید که رعایت کردن حروف کوچک و بزرگ برای این گزینه الزامی می باشد.
    • user_ip : به جای این گزینه می باید IP کاربر را قرار دهید.
    مثال :
    https://www.ip2info.ir/api/LHAa8mXVT6YYwVpCqLDRFkuiQuDIelQZ/188.158.100.128
  5. نتیجه نهایی اجرای API به فرمت JSON و با اطلاعاتی متناسب با پلن فعال شده شما در خروجی قابل دستیابی خواهد بود. در صورتی که عملیات بدون مشکل صورت پذیرفته باشد، مقدار عبارت error_code معادل 0 خواهد بود و نتایج مورد نیاز در زیر مجموعه data به نمایش در خواهند آمد.
    نمونه کامل خروجی json :
    {
      "data": {
        "ip": "94.183.159.186",
        "continent": "Asia",
        "country_name": "Iran (Islamic Republic of)",
        "country_code1": "IR",
        "country_code2": "IRN",
        "region": "Razavi Khorasan",
        "city": "Mashhad",
        "timezone": "Asia/Tehran",
        "language": "FA",
        "tel_prefix": "98",
        "currency": "IRR",
        "start_of_week": "Saturday",
        "org": "AS31549 Aria Shatel Company Ltd",
        "loc": "36.3156,59.5680"
      },
      "error_code": 0,
      "error_des": "No error"
    }
  6. در صورت بروز خطا در عملکرد API، یکی از حالت های زیر در خروجی ظاهر خواهند گردید:
    "error_code" : 1, "error_des": "Invalid API key",
    "error_code" : 2, "error_des": "Invalid IP",
    "error_code" : 3, "error_des": "Invalid requested output",
    "error_code" : 4, "error_des": "No daily requests remained",
    "error_code" : 5, "error_des": "Nothing found",
    "error_code" : 6, "error_des": "Unknown issue"