کلیدهای API
همه‌ی درخواست‌ها به API عمومی (https://api.plexit.ir/v1/*) با یک کلید
API احراز هویت می‌شوند. کلیدها در
کنسول پلکسیت مدیریت می‌شوند، نه از
طریق خودِ API. برای روایت گام‌به‌گام به احراز هویت
مراجعه کنید.
ساخت یک کلید
در صفحه‌ی «API و اتصال» یک کلید جدید بسازید و یک نام (۱ تا ۲۵۵ کاراکتر) برای آن انتخاب کنید. نام فقط برچسبی برای خود شماست و به جای دیگری ارسال نمی‌شود.
کلید خام فقط یک‌بار، هنگام ساخت، نمایش داده می‌شود و دیگر هرگز. بلافاصله آن را در یک Secrets Manager ذخیره کنید. اگر گمش کردید، کلید را باطل کنید و کلید جدیدی بسازید.
مشاهده‌ی کلیدها
فهرست کلیدها در کنسول، برای هر کلید این موارد را نشان می‌دهد:
| مورد | توضیح |
|---|---|
| نام | برچسبی که هنگام ساخت انتخاب کرده‌اید |
پیشوند (keyPrefix) | چند کاراکتر ابتدای کلید، مثلاً pk_live_8f2a… — برای تشخیص کلید، بدون افشای مقدار محرمانه |
| تاریخ ساخت | زمانی که کلید ساخته شده است |
| آخرین استفاده | زمان آخرین درخواستی که با این کلید احراز هویت شده است |
| وضعیت | فعال یا باطل‌شده |
کلید خام هرگز در این فهرست نمایش داده نمی‌شود.
ابطال یک کلید
کلید را از همان فهرست باطل کنید. ابطال بلافاصله اعمال می‌شود — اولین
درخواست بعدی به API عمومی با آن کلید خام، پاسخ 401 دریافت می‌کند. ابطال
برگشت‌پذیر نیست؛ برای ادامه‌ی کار یک کلید جدید بسازید.
قالب کلید
کلیدهای خام به شکل pk_live_<base64url> هستند و در هدر زیر ارسال می‌شوند:
Authorization: Bearer <raw_key>کل رشته را مبهم (Opaque) در نظر بگیرید — آن را تجزیه نکنید و به طول یا مجموعه‌ی کاراکترهای آن تکیه نکنید.
توصیه‌های امنیتی
- کلید را فقط در سمت سرور استفاده کنید؛ هرگز آن را در کد مرورگر، اپلیکیشن موبایل یا مخزن کد قرار ندهید.
- برای هر محیط یا سرویس (مثلاً Production و Staging) یک کلید جدا بسازید تا بتوانید هر کدام را مستقل باطل کنید.
- زمان «آخرین استفاده» را در کنسول مرور کنید و کلیدهای بلااستفاده را باطل کنید.
- اگر احتمال می‌دهید کلیدی لو رفته است، فوراً آن را باطل و کلید جدیدی جایگزین کنید.