ساخت و مدیریت کلید API
برای اتصال برنامه‌های خودتان به Plexit یک کلید API بسازید، آن را امن نگه دارید و در صورت نیاز باطلش کنید.
فهرست مطالب
کلید API به برنامه‌های سمت سرور شما اجازه می‌دهد با API عمومی Plexit کار کنند: فهرست دستیارها را بگیرند، پیام بفرستند و اسناد پایگاه دانش را مدیریت کنند. کلیدها در سطح حساب تعریف می‌شوند و در صفحهٔ کلیدهای API کنسول ساخته و مدیریت می‌شوند.
ساخت کلید
صفحهٔ کلیدها را باز کنید
از منوی کناری، گروه «حساب»، وارد کلیدهای API شوید.
«کلید جدید» را بزنید
پنجرهٔ «ساخت کلید API» باز می‌شود.
نام بگذارید
یک نام توصیفی وارد کنید، مثلاً «سرور اصلی» یا «محیط آزمایشی». این نام فقط برای خود شماست تا بعداً بدانید کلید کجا استفاده می‌شود.
کلید را کپی کنید
پنجرهٔ «کلید شما ساخته شد» کلید کامل را نشان می‌دهد. همین حالا آن را کپی کنید و در جای امنی ذخیره کنید، سپس «کپی کردم، ببند» را بزنید.
فهرست کلیدها
| ستون | معنی |
|---|---|
| نام | نامی که هنگام ساخت انتخاب کرده‌اید |
| پیشوند | چند نویسهٔ اول کلید (با pk_live_ شروع می‌شود) برای شناسایی؛ نمایش آن بی‌خطر است |
| تاریخ ساخت | زمان ساخت کلید |
| آخرین استفاده | آخرین زمانی که یک درخواست با این کلید انجام شده؛ اگر هنوز استفاده نشده «هرگز» |
| وضعیت | فعال یا باطلشده |
ابطال کلید
روی ابطال کنار کلید بزنید و پیام «این کلید باطل شود؟» را تأیید کنید. ابطال فوری است: هر برنامه‌ای که از این کلید استفاده می‌کند بلافاصله دسترسی‌اش قطع می‌شود و درخواست‌هایش پاسخ 401 می‌گیرند.
نگهداری امن کلید
- کلید را در متغیر محیطی یا سامانهٔ مدیریت اسرار سرور نگه دارید، نه در کد منبع.
- کلید API را هرگز در کد سمت مرورگر یا اپلیکیشن موبایل قرار ندهید. برای سایت از ویجت استفاده کنید که کلید سایت جداگانه و دامنهٔ مجاز دارد.
- برای هر محیط یا سرویس یک کلید جدا بسازید تا در صورت نشت، فقط همان را باطل کنید.
- کلیدهای بلااستفاده را باطل کنید. ستون «آخرین استفاده» به شناسایی آن‌ها کمک می‌کند.
# نمونه: نگهداری کلید در متغیر محیطی
export PLEXIT_API_KEY="pk_live_..."قدم بعدی: اولین درخواست به API.
کلید API به کدام دستیارها دسترسی دارد؟
کلید در سطح حساب است و به همهٔ دستیارهای همان حساب دسترسی دارد.
چند کلید میتوانم بسازم؟
میتوانید برای هر سرویس یا محیط یک کلید جدا بسازید و هرکدام را مستقل باطل کنید.
کلید باطلشده را میتوانم دوباره فعال کنم؟
خیر؛ ابطال برگشتپذیر نیست. یک کلید تازه بسازید.