پرش به مطلب اصلی

کلید API

کلید API ساده‌ترین راه اتصال برنامه‌ی شما به وب‌سرویس است. برخلاف توکن، کلید منقضی‌شدن دوره‌ای ندارد و نیازی به ورود با پیامک تأیید یا نوسازی نیست. کلید را در پنل می‌سازید و در هدر درخواست‌ها می‌فرستید. روش استفاده در احراز هویت با کلید API توضیح داده شده است.

ساخت کلید​

هنگام ساخت کلید موارد زیر را تعیین می‌کنید:

فیلدتوضیح
نام و توضیحبرای تشخیص کلید در فهرست
کلاینتبرنامه‌ای که کلید به آن تعلق دارد
آی‌پی‌های مجازاختیاری. هر مورد یک آدرس آی‌پی یا یک محدوده‌ی CIDR است

قواعد و محدودیت‌ها:

  • هر کاربر حداکثر ۱۰ کلید می‌تواند داشته باشد.
  • هر کلید حداکثر ۲۰ آی‌پی یا محدوده‌ی مجاز دارد. اگر فهرست آی‌پی خالی باشد، محدودیتی اعمال نمی‌شود.
  • حساب کاربری باید فعال و تأییدشده باشد.

نمایش کلید​

متن کامل کلید فقط یک بار، هنگام ساخت، نمایش داده می‌شود. سامانه فقط اثر رمزنگاری‌شده‌ی آن را نگه می‌دارد و بعداً نمی‌تواند متن کلید را دوباره نشان دهد. در فهرست کلیدها فقط چند نویسه‌ی ابتدایی دیده می‌شود. کلید را بلافاصله در محل امن ذخیره کنید.

غیرفعال‌سازی و حذف​

اگر کلیدی افشا شده یا دیگر لازم نیست، آن را غیرفعال یا حذف کنید. درخواست‌هایی که با کلید غیرفعال یا منقضی ارسال شوند با خطای 401 رد می‌شوند. می‌توانید نام، توضیح و آی‌پی‌های مجاز کلید را بعداً ویرایش کنید.

نکات امنیتی​

  • کلید را در کد سمت کاربر (مرورگر یا برنامه‌ی موبایل) قرار ندهید.
  • برای هر برنامه یا محیط، کلید جداگانه بسازید تا بتوانید یکی را بدون اثر بر دیگری لغو کنید.
  • در صورت ثابت‌بودن آی‌پی سرور، حتماً آی‌پی مجاز تعریف کنید.