رفتن به محتوا

ساخت و لغو کلیدهای API

کلید API با دسترسی محدود بسازید، مقدار محرمانه‌اش را یک‌بار کپی کنید و وقتی دیگر لازم نیست لغوش کنید.

به‌روزرسانی‌شده در

ساخت کلید

  1. API Keys را باز کنید.
  2. Create key را انتخاب کنید.
  3. Name توصیفی وارد کنید و زمان انقضای کلید را برگزینید.
  4. Restrict key را فعال نگه دارید و فقط مجوزهای نقطه پایانی موردنیاز یکپارچه‌سازی را انتخاب کنید. دسترسی نوشتن، دسترسی خواندن همان بخش API را نیز در بر می‌گیرد.
  5. اگر درخواست‌ها باید از نشانی‌های مشخصی بیایند، Restrict by IP address را فعال کنید و نشانی‌های IP یا بازه‌های CIDR مجاز را اضافه کنید.
  6. Create key را بزنید.

پیش از بستن پنجره API Key، مقدار محرمانه را کپی کنید. Threetone آن را دوباره نشان نمی‌دهد. آن را در مدیر اسرار سمت سرور یا متغیر محیطی نگه دارید و هرگز در کنترل نسخه ثبت نکنید یا در کد مرورگر نمایش ندهید.

کلیدهای API کاربر به حساب سازنده تعلق دارند. اگر اطلاعات ورود باید به فضای کاری تعلق داشته باشد، نه یک کاربر، از بخش Service Accounts استفاده کنید.

لغو کلید

در صفحه کلیدهای API، عمل لغو را برای کلید انتخاب کنید، نام و مقدار پوشانده‌شده آن را بررسی کنید و Revoke key را بزنید. لغو برگشت‌پذیر نیست و درخواست‌های دارای آن کلید فوراً ناموفق می‌شوند.

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