استفاده از سرویس

جست‌وجوی IP

برای دریافت اطلاعات شبکه، یک IP عمومی یا فهرستی از IPها را ارسال کنید. تمام درخواست‌های این صفحه به کلید دسترسی معتبر نیاز دارند.

نشانی پایهٔ سرویس: https://api.tarkav.ir/v1

جست‌وجوی یک نشانی

POST/v1/lookup

نشانی مورد نظر را در فیلد ip به‌صورت متن بفرستید. هر جست‌وجو یک واحد مصرف دارد.

cURL

curl --fail-with-body --max-time 10 https://api.tarkav.ir/v1/lookup \
  -H "Authorization: Bearer $TARKAV_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"ip":"2.144.0.1"}'

پاسخ یک شیء JSON است. فیلد found مشخص می‌کند که اطلاعاتی پیدا شده یا خیر. توضیح فیلدها و یک پاسخ نمونه در خواندن پاسخ آمده است.

جست‌وجوی چند نشانی

POST/v1/lookup/batch

فهرست نشانی‌ها را در آرایهٔ ips بفرستید. پاسخ، آرایهٔ results را با همان ترتیب ورودی برمی‌گرداند؛ بنابراین نتیجهٔ اول متعلق به نشانی اول است.

cURL · جست‌وجوی گروهی

curl --fail-with-body --max-time 10 https://api.tarkav.ir/v1/lookup/batch \
  -H "Authorization: Bearer $TARKAV_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"ips":["2.144.0.1","2001:4860:4860::8888"]}'

فهرست باید دست‌کم یک نشانی داشته باشد. سقف تعداد نشانی‌ها به پلن شما بستگی دارد.
هر ورودی یک واحد مصرف دارد؛ این مثال دو واحد مصرف می‌کند.
نشانی‌های تکراری در نتیجه حفظ می‌شوند و جداگانه مصرف دارند.
اگر یکی از ورودی‌ها نامعتبر یا غیرعمومی باشد، کل درخواست رد می‌شود. پیش از ارسال دوباره، ورودی را اصلاح کنید.

دیدن IP اتصال خود

GET/v1/me

این درخواست فقط IP اتصال درخواست‌کننده را برمی‌گرداند و اطلاعات شبکه را جست‌وجو نمی‌کند.

cURL · IP اتصال

curl --fail-with-body --max-time 10 https://api.tarkav.ir/v1/me \
  -H "Authorization: Bearer $TARKAV_API_KEY"

اگر درخواست را از سرور برنامه می‌فرستید، IP خروجی همان سرور را می‌بینید. برای شناخت شبکهٔ یک کاربر، IP او را به درخواست جست‌وجو بدهید.

نشانی‌های پشتیبانی‌شده

نشانی‌های عمومی IPv4 و IPv6 پذیرفته می‌شوند. یک IP بفرستید؛ نام دامنه، URL، شمارهٔ درگاه یا بازهٔ شبکه ورودی این درخواست‌ها نیست.

نشانی‌های خصوصی، محلی و رزروشده مانند 127.0.0.1 یا 192.168.1.1 پشتیبانی نمی‌شوند. برای معنی پیام‌های پاسخ، رفع خطاها را ببینید.