مستنداتشروع
کلیدها
ساخت، چرخاندن و لغو کلید، و محدود کردن آن به دامنه یا آدرس IP.
آخرین ویرایش: ۲۱ آبان ۱۴۰۵
یک کلید هم رمز SMTP است و هم توکن API. هر دو راه با همان راز کار می‌کنند.
ساخت کلید
در پنل، «کلیدها» را باز کنید و کلید تازه بسازید. هر کلید این‌ها را دارد:
| ویژگی | توضیح |
|---|---|
| نام | برای شناختن کلید در پنل |
| شناسه | ثابت می‌ماند و نام کاربری SMTP است |
| راز | با sd_live_ شروع می‌شود؛ رمز SMTP و توکن API |
| تاریخ انقضا | اختیاری |
| آدرس‌های IP مجاز | اختیاری؛ فقط از این آدرس‌ها پذیرفته می‌شود |
| دامنه‌های مجاز | اختیاری و فقط در پلن‌های پولی؛ کلید فقط از این دامنه‌ها می‌فرستد |
ساختن کلید نیاز به تأیید رمز عبور دارد (به‌جز اولین کلید حساب).
راز فقط یک بار نشان داده می‌شود
سندک راز را نگه نمی‌دارد؛ فقط هش SHA-256 آن را ذخیره می‌کند. برای همین دوباره نمی‌تواند نشانش بدهد، و کسی که به پایگاه داده‌ی ما دسترسی پیدا کند هم راز شما را به دست نمی‌آورد.
هشدار: راز را در مخزن کد، لاگ یا پیام چت نگذارید. آن را در متغیر محیطی یا مدیر رمز نگه دارید. پیشوند
sd_live_عمداً قابل جست‌وجو است تا ابزارهای اسکن راز، نشت آن را پیدا کنند.
چرخاندن
«چرخاندن» برای همان کلید رازی تازه می‌سازد. شناسه (نام کاربری SMTP) همان می‌ماند، ولی راز قبلی همان لحظه از کار می‌افتد. پس اول جایی که راز را به کار می‌برید آماده‌ی تعویض باشید، بعد بچرخانید. چرخاندن بدون تأیید رمز عبور انجام نمی‌شود.
لغو
لغو کلید آن را برای همیشه غیرفعال می‌کند و ارسال‌های بعدی با آن 401 می‌گیرند. اگر کلید لو رفته، همین را بزنید یا بچرخانید.
محدود کردن
برای کم کردن خطر لو رفتن:
- هر سرویس را کلید جدا بدهید، تا لغو یکی بقیه را قطع نکند.
- در پلن‌های پولی، کلید را به دامنه‌ای که لازم دارد محدود کنید. ارسال از دامنه‌ی دیگر خطای
key_not_allowed_for_domain(۴۰۳) می‌دهد. - اگر سرور شما IP ثابت دارد، آن را در آدرس‌های مجاز بگذارید. از آدرس دیگر درخواست
401می‌گیرد. - برای دسترسی موقت، تاریخ انقضا بگذارید.
احراز هویت در API
راز را به‌شکل Bearer بفرستید:
Authorization: Bearer sd_live_…اگر کلید نامعتبر، لغو‌شده، منقضی، از آدرس غیرمجاز، یا متعلق به حساب تعلیق‌شده باشد، پاسخ در همه‌ی حالت‌ها یکی است:
{ "message": "Unauthenticated." }عمداً دلیل را نمی‌گوییم تا کسی با آزمون و خطا نتواند کلیدها را بشناسد.
تعداد کلید
سقف تعداد کلیدهای فعال هر حساب در صفحه‌ی «پلن» دیده می‌شود (پیش‌فرض ۲۰). بعد از رسیدن به سقف، ساخت کلید با خطای credential_limit_reached رد می‌شود؛ کلیدی که لازم ندارید را لغو کنید.