در بخش کلیدهای API می‌توانید کلیدهای دسترسی موردنیاز برای اتصال نرم‌افزارها، وب‌سایت‌ها و سرویس‌های خود به پنل پیامکی مکث اس‌ام‌اس را ایجاد و مدیریت کنید. این کلیدها برای احراز هویت درخواست‌های API استفاده می‌شوند و امکان ارتباط برنامه‌نویسی‌شده با پنل را فراهم می‌کنند.

کلید API پیامکی

مدیریت کلیدهای API

در صفحه اصلی این بخش، تعداد کلیدهای فعال و تعداد کلیدهای ایجادشده نمایش داده می‌شود. هر کاربر می‌تواند حداکثر ۵ کلید فعال و در مجموع ۲۰ کلید API داشته باشد.

برای ایجاد کلید دسترسی جدید، روی دکمه کلید جدید یا گزینه اولین کلید را بسازید کلیک کنید تا فرم ایجاد کلید API نمایش داده شود.

ایجاد کلید API جدید

برای ساخت کلید دسترسی، اطلاعات موردنیاز را در فرم مربوطه وارد کنید:

  • عنوان کلید: یک نام مشخص برای کلید انتخاب کنید تا بتوانید کاربرد آن را شناسایی و کلیدهای مختلف را از یکدیگر تفکیک کنید؛ برای مثال، می‌توانید نام وب‌سایت یا نرم‌افزاری را که از این کلید استفاده می‌کند، وارد کنید.
  • IP Whitelist: در صورت نیاز، آدرس IPهای مجاز برای استفاده از کلید را مشخص کنید. با استفاده از این قابلیت می‌توانید دسترسی API را به آدرس‌های IP تعیین‌شده محدود کنید.

برای افزودن آدرس IP، روی گزینه افزودن IP کلیک کنید و آدرس موردنظر را وارد کنید. اگر فهرست IPها خالی باشد، دسترسی از هر آدرس IP مجاز خواهد بود؛ بنابراین، برای محدود کردن دسترسی به IPهای مشخص، آدرس‌های مجاز را در این قسمت ثبت کنید.

ساخت کلید API

پس از تکمیل اطلاعات، روی دکمه ساخت کلید کلیک کنید تا کلید API ایجاد شود. برای صرف‌نظر از ایجاد کلید نیز می‌توانید گزینه انصراف را انتخاب کنید.

نکات مهم امنیتی

توکن API فقط یک‌بار، بلافاصله پس از ساخت کلید، نمایش داده می‌شود. پس از ایجاد کلید، توکن را در محلی امن ذخیره کنید؛ زیرا امکان مشاهده مجدد آن وجود ندارد. از قراردادن توکن در اختیار افراد غیرمجاز یا انتشار آن در کدهای عمومی خودداری کنید.

هر کاربر حداکثر می‌تواند ۵ کلید فعال و ۲۰ کلید در مجموع داشته باشد. در صورت غیرفعال کردن یک کلید، امکان فعال‌سازی مجدد آن وجود ندارد. برای آزاد کردن ظرفیت ایجاد کلید جدید، می‌توانید کلیدهای غیرفعال‌شده را حذف کنید.

هنگام ایجاد کلید، سطح دسترسی آن را با توجه به نیاز خود تنظیم کنید و در صورت امکان، با استفاده از قابلیت IP Whitelist، دسترسی را به آدرس‌های IP مورداعتماد محدود کنید.