مدیریت کلیدهای API
کلیدهای API خود را بسازید، مدیریت و پایش کنید
مدیریت کلیدهای API
کلیدهای API برای احراز هویت برنامه‌های شما هنگام ارسال درخواست به پلتفرم Aize استفاده می‌شوند.
ساخت کلید API
پیش‌نیازها
- حداقل ۵ دلار موجودی کیف پول لازم است
- در صورت ناکافی بودن موجودی، به صفحه کیف پول هدایت می‌شوید تا شارژ کنید
مراحل
-
روی دکمه «ساخت کلید API» کلیک کنید
-
اطلاعات لازم را وارد کنید:
- برچسب: نامی قابل‌فهم برای انسان (مثلاً «اپلیکیشن عملیاتی»، «آزمایش»)
- سقف ماهانه (اختیاری): حداکثر هزینه در ماه به دلار
- مدل‌های مجاز (اختیاری): کلید را به مدل‌های خاصی محدود کنید
- دامنه: شخصی یا تیمی (تیمی فقط برای مدیران/مالکان در دسترس است)
-
روی «ساخت کلید» کلیک کنید
-
⚠️ مهم: بلافاصله کلید API را کپی کنید — فقط یک‌بار نمایش داده می‌شود!
دامنه‌های کلید
کلیدهای شخصی
- توسط هر عضوی قابل‌ساخت است
- فقط برای سازنده قابل‌مشاهده است
- با تیم قابل‌اشتراک‌گذاری نیست
- مصرف به‌صورت جداگانه پیگیری می‌شود
- برای پروژه‌های شخصی مناسب است
کلیدهای تیمی (فقط مدیران/مالکان)
- برای همه مدیران/مالکان قابل‌مشاهده است
- در سطح فضای کاری به اشتراک گذاشته می‌شود
- مصرف آن در تحلیل تیمی نمایان می‌شود
- برای سرویس‌های عملیاتی ایده‌آل است
جزئیات کلید API
هر کارت کلید API موارد زیر را نمایش می‌دهد:
اطلاعات پایه
- کلید نقاب‌دار:
sk-****...last8chars - دکمه کپی: برای کپی کلید نقاب‌دار کامل کلیک کنید
- برچسب: نام دلخواه شما
- تاریخ ساخت: تاریخ و ساعت ایجاد
- ساخته‌شده توسط: عضوی که آن را ساخته (نام + ایمیل)
- آخرین استفاده: زمان آخرین فراخوانی API
مصرف و سقف‌ها
نوار پیشرفت مصرف ماهانه
- هزینه ماه جاری را نشان می‌دهد
- قالب:
$X.XX / $Y.YY (Z%) - در روز اول هر ماه به‌طور خودکار از نو شروع می‌شود
- رنگ‌بندی:
- سبز: کمتر از 75% سقف
- زرد: بین 75 تا 90% سقف
- قرمز: بیش از 90% سقف
هنگام رسیدن به سقف ماهانه:
- API خطای
402 Payment Requiredبرمی‌گرداند - کلید در ماه بعد به‌طور خودکار دوباره کار می‌کند
- یا در هر زمان می‌توانید سقف را افزایش دهید
محدودیت‌های مدل
اگر کلید را به مدل‌های خاصی محدود کرده باشید:
- نشان مدل‌های مجاز نمایش داده می‌شود
- با نگه‌داشتن نشانگر، فهرست مدل‌های مجاز را ببینید
- درخواست به سایر مدل‌ها خطای
403 Forbiddenبرمی‌گرداند
مدیریت کلیدهای API
مسدود کردن یک کلید
بدون حذف کلید، آن را موقتاً غیرفعال کنید:
- روی دکمه «مسدودسازی» روی کارت کلید کلیک کنید
- عملیات را تأیید کنید
- کلید بلافاصله از کار می‌افتد
- همه درخواست‌ها خطای
401 Unauthorizedبرمی‌گردانند
موارد استفاده:
- شناسایی فعالیت مشکوک
- افشا یا نشت کلید
- توقف موقت یک سرویس
برای رفع مسدودی:
- روی دکمه «رفع مسدودی» کلیک کنید
- کلید بلافاصله دوباره کار می‌کند
ابطال یک کلید
یک کلید API را برای همیشه حذف کنید:
- روی دکمه «ابطال» کلیک کنید
- حذف را تأیید کنید
- کلید برای همیشه حذف می‌شود
- قابل بازیابی نیست
⚠️ هشدار: این عملیات قابل بازگشت نیست!
زمان استفاده:
- کلید دیگر نیازی نیست
- جایگزینی با کلید جدید
- تأیید نقض امنیتی
پایش مصرف
نحوه استفاده از کلیدهای خود را زیر نظر بگیرید:
تحلیل به تفکیک هر کلید
در صفحهٔ گزارش فراخوانی‌های API مشاهده کنید:
- به گزارش فراخوانی‌های API بروید
- بر اساس کلید API فیلتر کنید
- همه درخواست‌های ساخته‌شده با آن کلید را ببینید:
- زمان
- مدل استفاده‌شده
- توکن مصرف‌شده
- هزینه هر درخواست
- تأخیر
- وضعیت موفقیت/خطا
هزینه ماهانه
هزینه هر کلید را پیگیری کنید:
- مجموع ماه جاری
- پیشرفت نسبت به سقف (در صورت تعیین)
- هزینه تاریخی (مشاهده ماه‌های گذشته)
بهترین شیوه‌های امنیتی
نگهداری کلید
✅ انجام دهید:
- کلیدها را در متغیرهای محیطی ذخیره کنید
- از سرویس‌های مدیریت اسرار استفاده کنید (AWS Secrets Manager، HashiCorp Vault)
- کلیدها را به‌طور منظم چرخش دهید
- برای محیط توسعه/آزمایش/تولید از کلیدهای متفاوت استفاده کنید
❌ انجام ندهید:
- کلیدها را در سیستم کنترل نسخه ثبت نکنید
- کلیدها را در Slack یا ایمیل به اشتراک نگذارید
- در کد برنامه هاردکد نکنید
- از یک کلید در همه محیط‌ها استفاده نکنید
چرخش کلید
برنامه پیشنهادی:
- کلیدهای تولید: هر 90 روز
- کلیدهای توسعه: هر 180 روز
- بلافاصله: در صورت افشای کلید
مراحل چرخش:
- یک کلید API جدید بسازید
- متغیرهای محیطی برنامه خود را به‌روزرسانی کنید
- پیکربندی به‌روزشده را استقرار دهید
- عملکرد کلید جدید را تأیید کنید
- کلید قدیمی را باطل کنید
پایش
برای موارد زیر هشدار تنظیم کنید:
- مصرف بالا: نزدیک شدن به سقف ماهانه
- الگوهای غیرعادی: افزایش ناگهانی درخواست‌ها
- خطاها: افزایش نرخ خطا
- مکان‌های جدید: درخواست از IPهای غیرمنتظره (در صورت پایش)
مجوزهای کلید API بر اساس نقش
| عملیات | عضو | مدیر | مالک |
|---|---|---|---|
| ساخت کلید شخصی | ✅ | ✅ | ✅ |
| ساخت کلید تیمی | ❌ | ✅ | ✅ |
| مشاهده کلیدهای خود | ✅ | ✅ | ✅ |
| مشاهده همه کلیدهای تیم | ❌ | ✅ | ✅ |
| مسدودسازی کلیدهای خود | ✅ | ✅ | ✅ |
| مسدودسازی کلیدهای تیم | ❌ | ✅ | ✅ |
| ابطال کلیدهای خود | ✅ | ✅ | ✅ |
| ابطال کلیدهای تیم | ❌ | ✅ | ✅ |
مشکلات رایج
خطای «موجودی ناکافی»
مشکل: امکان ساخت کلید API به دلیل کمبود موجودی کیف پول وجود ندارد
راه‌حل:
- در پنجره خطا روی «Deposit» کلیک کنید
- اگر اعتبار کافی ندارید، اعتبار کیف پول را دست‌کم ۱۰۰٬۰۰۰ تومان با زرین‌پال یا ۱۰ دلار با رمزارز افزایش دهید (حداقل موجودی برای ساخت کلید، معادل ۵ دلار است)
- دوباره برای ساخت کلید تلاش کنید
«سقف ماهانه تمام شده است»
مشکل: کلید در میانه ماه از کار می‌افتد
راه‌حل:
- به صفحه کلیدهای API بروید
- کلید موردنظر را پیدا کنید
- روی کارت کلید کلیک کنید تا باز شود
- سقف ماهانه را افزایش دهید
- یا صبر کنید تا سقف در ماه بعد خودکار از نو شروع شود
«کلید API نامعتبر است»
مشکل: API خطای 401 Unauthorized برمی‌گرداند
علل احتمالی:
- کلید باطل شده است
- کلید مسدود شده است
- قالب کلید نادرست است
- فضای کاری منجمد شده است
راه‌حل:
- وضعیت کلید را در داشبورد بررسی کنید
- مطمئن شوید موجودی کیف پول بیشتر از 0 دلار است
- از استفاده از کلید صحیح مطمئن شوید
- در صورت نیاز کلید جدیدی بسازید
استفاده از کلیدهای API
برای نمونه‌های کد استفاده از کلیدهای API خود به راهنمای شروع سریع مراجعه کنید.
استفاده پایه:
Authorization: Bearer YOUR_API_KEYیا:
x-api-key: YOUR_API_KEY