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


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

  1. وارد بخش مدیریت نرم افزارها شده و یک پلن دلخواه را برای نرم افزار خود فعال نمایید.
  2. با فعال سازی هر نرم افزار و پلن ، یک کلید API به شما ارائه خواهد شد.
  3. نرم افزار شما از هر نوع (وب سایت ، اپلیکیشن موبایل و ...) می باید در هنگام مراجعه و یا ورود کاربر ، IP اینترنتی وی را شناسایی نماید. دقت نمایید که ممکن است کاربر در حال استفاده از یک پراکسی و یا مواردی نظیر آن باشد. در چنین شرایطی می باید تا حد امکان به IP واقعی کاربر دست پیدا کرد. مبنی کار API این سایت ، IP ارسال شده از سوی شما خواهد بود.
  4. درخواست خود را به فرمت زیر برای ip2info ارسال کنید.
    https://www.ip2info.ir/api/api_key/user_ip/output_format/
    در الگوی فوق ، 3 قسمت متغیر وجود دارند که به شرح آنها می پردازیم :
    • api_key : کلیدی است که در گزینه شماره 2 به آن اشاره شد. دقت نمایید که رعایت کردن حروف کوچک و بزرگ برای این گزینه الزامی می باشد.
    • user_ip : به جای این گزینه می باید IP کاربر را قرار دهید.
    • output_format : این بخش مشخص می کند که شما انتظار دریافت چه نوع پاسخی از سوی API را دارید. مقدار مربوط به این گزینه می تواند معادل text ، json و یا xml باشد.
    مثال :
    https://www.ip2info.ir/api/LHAa8mXVT6YYwVpCqLDRFkuiQuDIelQZ/188.158.100.128/json/
  5. بسته به نوع خروجی درخواستی از API ، دستور تحلیل پاسخ دریافتی از سرور را در نرم افزار خود قرار داده و بر اساس نتایج نهایی ، تنظیمات لازم را برای کاربر خود اعمال نماید. پاسخ ارسالی از سوی API بسته به پلن انتخابی شما می تواند متفاوت باشد. در زیر کامل ترین شکل پاسخ ها حاوی کد کشور ، نام کشور ، استان ، شهر ، نام قاره ، واحد ارز کشور ، منطقه زمانی و موقعیت طول و عرض جغرافیایی ، به سه فرمت text ، json و xml را با مثال هایی مشاهده خواهید نمود. دقت نمایید که در صورتی که با توجه به نوع پلن انتخابی خود پاسخی برای هر یک از مقادیر فوق قابل دریافت نباشد ، عبارت null در خروجی آن مورد قرار خواهد گرفت.
    خروجی از نوع text :
    IR/Iran, Islamic Republic of/Khorasan-e Razavi/Mashhad/Asia/IRR/+04:30/25.297/20.6062
    خروجی از نوع json :
    {
        "country_code":"IR",
        "country_name":"Iran, Islamic Republic of",
        "province":"Khorasan-e Razavi",
        "city":"Mashhad",
        "continent":"Asia",
        "currency":"IRR",
        "timezone":"+4:30",
        "latitude":"25.297",
        "longitude":"20.6062"
    }
    خروجی از نوع xml :
    <?xml version="1.0" encoding="UTF-8" ?>
        <root>
            <country_code>IR</country_code>
            <country_name>Iran, Islamic Republic of</country_name>
            <province>Khorasan-e Razavi</province>
            <city>Mashhad</city>
            <continent>Asia</continent>
            <currency>IRR</currency>
            <timezone>+4:30</timezone>
            <latitude>25.297</latitude>
            <longitude>20.6062</longitude>
        </root>
    </xml>
    

در صورت نیاز لینک های زیر را نیز بازدید نمایید :