شروع سریع
برای اولین جستوجو به یک حساب تارکاو، کلید دسترسی و یک IP عمومی نیاز دارید.
۱. حساب بسازید
در تارکاو ثبتنام کنید و ایمیل خود را تأیید کنید. سپس وارد داشبورد شوید. برای شروع میتوانید از پلن رایگان استفاده کنید؛ سهمیهٔ فعال شما در داشبورد نمایش داده میشود.
۲. کلید دسترسی بگیرید
در بخش کلیدهای دسترسی، دکمهٔ کلید تازه را بزنید. نامی انتخاب کنید که کاربرد کلید را مشخص کند، مثلاً «وبسایت من»، و محیط مورد نیاز را انتخاب کنید.
کلید کامل فقط همان یکبار نمایش داده میشود. آن را در محل امن ذخیره کنید. اگر بعداً به آن دسترسی نداشتید، باید کلید جدیدی بسازید.
۳. اولین جستوجو را انجام دهید
سادهترین راه، آزمایشگاه داشبورد است. کلید و یک IP عمومی را وارد کنید و اجرای درخواست را بزنید. این جستوجو یک واحد از سهمیه مصرف میکند.
برای استفاده در برنامه، کلید را در متغیر محیطی TARKAV_API_KEY روی سرور خود قرار دهید. دستور زیر مقدار همین متغیر را میخواند؛ پیش از اجرا مطمئن شوید تنظیم شده است.
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"}'۴. پاسخ را بررسی کنید
اگر found برابر true باشد، اطلاعاتی برای شبکه پیدا شده است. اگر false باشد، جستوجو انجام شده اما رکوردی برای آن نشانی در دادههای فعلی وجود ندارد.
همهٔ فیلدها در همهٔ پاسخها حاضر نیستند. برای استفادهٔ درست از شهر، استان، اپراتور و سایر اطلاعات، خواندن پاسخ را ببینید. اگر درخواست خطا داشت، از راهنمای رفع خطاها کمک بگیرید.