کلید دسترسی

کلید دسترسی، برنامهٔ شما را به حساب تارکاو متصل می‌کند. هر درخواست جست‌وجو، حتی در پلن رایگان، به کلید معتبر نیاز دارد.

ساخت و نگهداری کلید

از بخش کلیدهای دسترسی در داشبورد یک کلید بسازید. برای هر برنامه نامی مشخص انتخاب کنید تا بعداً بدانید کدام کلید را باید تعویض یا لغو کنید.

کلید کامل فقط هنگام ساخت نمایش داده می‌شود و دوباره قابل دریافت نیست. آن را در تنظیمات امن سرور نگه دارید. در نمونه‌های این راهنما، برنامه کلید را از متغیر محیطی TARKAV_API_KEY می‌خواند.

کلیدهای محیط اصلی با tk_live_ و کلیدهای محیط آزمایش با tk_test_ شروع می‌شوند. آزمایشی بودن کلید به معنی مصرف رایگان یا سهمیهٔ جداگانه نیست؛ مصرف را در داشبورد بررسی کنید.

ارسال کلید در درخواست

کلید را در سربرگ Authorization و بعد از واژهٔ Bearer بفرستید. بین این دو مقدار یک فاصله لازم است. برای درخواست‌هایی که بدنهٔ JSON دارند، سربرگ Content-Type را هم تنظیم کنید.

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"}'

تعویض یا لغو کلید

برای تعویض بدون قطع برنامه، ابتدا کلید جدیدی بسازید، آن را در تنظیمات برنامه جایگزین و یک درخواست را امتحان کنید. سپس کلید قبلی را لغو کنید.

اگر کلیدی افشا شده یا دیگر استفاده نمی‌شود، از گزینهٔ لغو در داشبورد استفاده کنید. درخواست‌های بعدی با آن کلید پذیرفته نمی‌شوند.

اگر کلید پذیرفته نشد

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