ساخت و لغو کلیدهای دسترسی API
کلید را با کمترین مجوز و انقضای مناسب بسازید، یکبار امن نگه دارید، مصرف و آخرین استفاده را بخوانید و در زمان درست لغو کنید.
چه کسی میتواند کلید API بسازد؟
صفحهٔ «API توسعهدهندگان» در مسیر /panel/developer-api برای ساخت و مدیریت کلیدهایی است که نرمافزار دیگری با آن به دادههای فروشگاه دسترسی میگیرد. فقط مالک یا مدیر فروشگاه میتواند کلیدها را مدیریت کند. قابلیت ساخت کلید به اشتراک فعال هم وابسته است؛ اگر قابلیت در طرح فعلی روشن نیست، صفحه فقط وضعیت را نشان میدهد و ساخت کلید تازه در دسترس نخواهد بود.
این صفحه فقط کلید دسترسی را صادر میکند؛ آدرس endpoint، قالب درخواست، نسخهبندی یا محدودیت هر API را از مستند فنی همان سرویس بگیرید. از روی نام مجوز یا فهرست کلیدها، قرارداد یک endpoint را حدس نزنید.
ساخت کلید با کمترین دسترسی لازم
- در فیلد «نام کلید» نام نرمافزار یا کاربرد را وارد کنید، مثلاً «همگامسازی حسابداری». نام مبهمی مثل «کلید جدید» بعداً پیدا کردن و لغو کلید را دشوار میکند.
- فقط مجوزهایی را علامت بزنید که اتصال واقعاً نیاز دارد. دسترسیهای موجود ممکن است شامل خواندن کاتالوگ و محصولات، خلاصهٔ سفارشها و موجودی انبارها باشد. داشتن چند مجوز کاربردی بیشتر، آسیب یک کلید افشاشده را هم گستردهتر میکند.
- در صورت نیاز زمان انقضا انتخاب کنید. انقضا اختیاری است؛ اگر آن را خالی بگذارید کلید تاریخ پایان ثبتشده ندارد. برای اتصال موقت یا آزمایشی، تاریخ پایان تعیین کنید.
- «ساخت کلید» را بزنید. صفحه راز کامل کلید را فقط همین یک بار نشان میدهد؛ همان لحظه آن را در مخزن امن اسرار نرمافزار مقصد ثبت کنید.
- اگر لازم است، از دکمهٔ کپی استفاده کنید و پس از ذخیره امن، راز را از کلیپبورد و صفحههای قابلدسترسی دیگر پاک کنید. بعد از خروج از صفحه راز را دوباره نمیتوانید ببینید.
کلید را در کد سمت مرورگر، مخزن عمومی، تصویر، فایل اشتراکی یا لاگ درخواست قرار ندهید. اگر کلید را گم کردید، راز قبلی قابل بازیابی نیست؛ کلید تازه بسازید، اتصال مقصد را به آن منتقل کنید و سپس کلید قدیمی را با دلیل مشخص غیرفعال کنید.
کنترل مصرف و استفاده
بالای صفحه مصرف ماه جاری و سقف را نشان میدهد. مقدار نامحدود با علامت بینهایت نمایش داده میشود. این عدد میزان مصرف دوره را نشان میدهد، نه تعداد کلیدهای فعال. فهرست کلیدها تعداد فعال، پیشوند ماسکشده، مجوزها، تاریخ ساخت، آخرین استفاده، انقضا و در صورت وجود IP آخرین استفاده را نشان میدهد. راز کامل در فهرست یا جزئیات بعدی نمایش داده نمیشود.
وضعیت کلید میتواند فعال، منقضی یا لغوشده باشد. پیش از بررسی دسترسی نرمافزار، وضعیت و تاریخ انقضا را ببینید. «آخرین استفاده» و IP سرنخ ممیزیاند و ممکن است هنوز خالی باشند اگر کلید تازه ساخته شده یا درخواست معتبری نداشته است.
لغو دسترسی
اگر نرمافزار از این کلید دیگر استفاده نمیکند، آن را لغو کنید. دکمهٔ «غیرفعالکردن» دلیل میخواهد؛ دستکم هشت نویسه وارد کنید تا معلوم باشد چرا دسترسی قطع شده است. پیش از لغو، بررسی کنید اتصال دیگری از همین کلید استفاده نکند. لغو یکباره و فوری روی درخواستهای بعدی اثر میگذارد و کلید را به حالت فعال برنمیگرداند؛ برای بازگشت نرمافزار، کلید تازه بسازید و امن تحویل دهید.
اگر احتمال میدهید کلید لو رفته، آن را فوراً لغو کنید، دلیل رخداد را ثبت کنید و سپس کلید جایگزین با مجوز حداقلی بسازید. در نرمافزار مقصد هم راز قبلی را از تنظیمات و لاگ پاک کنید. اگر درخواستهای مشکوک میبینید، زمان، پیشوند کلید و IP قابل مشاهده را برای بررسی داخلی ثبت کنید؛ راز کامل را در گزارش نیاورید.
خطاهای رایج
اگر پیام میگوید فقط مالک یا مدیر میتواند کلید بسازد، از مدیر فروشگاه بخواهید عملیات را انجام دهد. اگر طرح قابلیت را فعال نکرده، مدیر حساب یا مسئول طرح باید مسیر فعالسازی را بررسی کند. اگر ساخت کلید خطا میدهد، نام غیرخالی، دستکم یک مجوز و تاریخ انقضای معتبر را کنترل کنید. اگر نرمافزار مقصد دسترسی ندارد، وضعیت کلید، مجوزهای انتخابشده، زمان انقضا و مشخصات اتصال را با مستند API مقایسه کنید.
برای پشتیبانی، نام کلید، وضعیت، مجوزها، زمان خطا و پیشوند ماسکشده کافی است. راز کامل، کد ورود یا اطلاعات مشتری را هرگز ارسال نکنید.