دریافت کلید API
کلید API خود را از پنل نجوا بسازید و آن را امن نگه دارید.
برای فراخوانی هر یک از سرویسهای پیامک نجوا به یک کلید API نیاز دارید. این کلید هویت حساب شما را مشخص میکند و ساخت آن از پنل کاربری انجام میشود.
ساخت کلید از پنل
گام ۱ — رفتن به «تنظیمات ← توسعهدهندگان»
وارد پنل کاربری نجوا شوید. از منوی کناری روی «تنظیمات» کلیک کنید تا باز شود، سپس گزینهٔ «توسعهدهندگان» را انتخاب کنید.
گام ۲ — ساخت کلید در تب «api key»
در صفحهٔ توسعهدهندگان، تب «api key» را انتخاب کنید. این صفحه دو بخش دارد؛ بخش بالایی «api key پیامک و پوشنوتیفیکیشن» همان چیزی است که برای سرویسهای پیامک لازم دارید (بخش دوم، «api key ایمیل»، مربوط به سرویس ایمیل است).
اگر هنوز کلیدی نساخته باشید پیام «شما در حال حاضر هیچ api key ندارید!» را میبینید. روی دکمهٔ «+ ایجاد api key جدید» کلیک کنید.
کلید ساختهشده بلافاصله نمایش داده میشود. آن را در جای امنی — مثل مدیر رمز عبور یا سرویس مدیریت اسرارِ زیرساخت خودتان — ذخیره کنید.
کلید API معادل رمز عبور حساب شماست: هر کسی که آن را داشته باشد میتواند از اعتبار پیامک شما خرج کند.
- هرگز آن را در کد سمت کاربر (جاوااسکریپت مرورگر، اپلیکیشن موبایل، صفحهٔ HTML) قرار ندهید؛ در آنجا هر کاربری میتواند آن را ببیند.
- آن را در مخزن کد، اسکرینشات یا تیکت پشتیبانی کپی نکنید.
- کلید را در متغیر محیطی نگه دارید، نه داخل سورس.
- فراخوانی API را همیشه از سرور خودتان انجام دهید، نه از مرورگر کاربر.
بعد از ساخت کلید
پیش از نخستین درخواست، دو نکته را در نظر بگیرید:
- سرویسهای نسخهٔ ۱ فقط از آیپیهای وایتلیستشده قابل فراخوانیاند. راهنمای وایتلیست IP را ببینید.
- محل قرار گرفتن کلید در درخواست، بسته به نسخهٔ API فرق میکند. جزئیات دقیق در احراز هویت آمده است.