مرجع توسعه‌دهندگان

EFARS API

امنیت کلید API

از ایجاد تا چرخش و ابطال کلید در برنامه واقعی.

راهنمای اتصال مشتریان
curl · Python · JavaScript

نگهداری امن

  • از متغیر محیطی یا secret manager سرور استفاده کنید.
  • کلید را در متغیرهای عمومی build فرانت‌اند مانند VITE_* قرار ندهید.
  • کلیدها را از لاگ، گزارش خطا، تصاویر و مخزن کد حذف کنید.
  • برای محیط توسعه و تولید کلید جدا با دسترسی لازم بسازید.

در صورت افشای کلید

  • کلید افشاشده را در پنل غیرفعال یا حذف کنید.
  • گزارش مصرف و برنامه‌های وابسته را بررسی کنید.
  • کلید جدید بسازید و در محیط امن جایگزین کنید.
  • منبع نشت را اصلاح کنید؛ حذف متن از یک commit به‌تنهایی دسترسی کلید را لغو نمی‌کند.

گزارش خطای قابل اشتراک

برای پیگیری مشکل، زمان، پروتکل، نام مدل، HTTP status، error.code و شناسه درخواست را در صورت وجود ثبت کنید. هدر احراز هویت، کلید، اطلاعات شخصی و متن حساس ورودی را در گزارش عمومی منتشر نکنید.