🔐 احراز هویت

احراز هویت برای تمام نقاط پایانی API در IPPanel Edge API الزامی است. این بخش تمام نقاط پایانی مرتبط با احراز هویت از جمله ورود به سیستم، مدیریت توکن و بازیابی رمز عبور را پوشش می‌دهد.

ℹ️ نکات مهم

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

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

برای دسترسی به کلید API:

• وارد حساب کاربری خود در پنل شوید

• به بخش برنامه نویسان-> کلید های دسترسی بروید

• کلید دسترسی خود را ایجاد و برای درخواست ها از آن استفاده نمایید

آدرس پایه

همه نقاط پایانی احراز هویت از URL پایه استفاده می‌کنند: https://edge.ippanel.com/v1

مراحل احراز هویت

پنل IPPanel برای احراز کردن هویت کاربران از چند مرحله استفاده می نماید

• احراز نام کاربری و رمز عبور - نام کاربری و رمز عبور کاربر دریافت و چک می شود
• رمز یکبار مصرف - بسته به اینکه کاربر از چه روشی برای تولید رمز یکبار مصرف استفاده میکند(رمزساز گوگل/دریافت پیامک) سیستم رمز را دریافت کرده و صحت سنجی می کند
• توکن دسترسی - در نهایت توکن دسترسی صادر میشود که در تمامی API های گفته شده در این داکیومنت قابل استفاده می باشد

هدر درخواست

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

Authorization: YOUR_TOKEN_HERE

مراحل این بخش

این بخش شامل API های زیر است که تقریبا تمامی عملیات مربوط به احراز یک کاربر را پشتیبانی می کنند:

• Login API - صحت سنجی نام کاربری و رمزعبور کاربر
• Send SMS OTP - درخواست ارسال رمز یکبار مصرف به صورت پیامک
• Confirm OTP Login - وارد نمودن رمز یکبار مصرف دریافت شده از طریق پیامک و یا رمزساز گوگل
• Forgot Password - بازیابی کلمه عبور حساب کاربری در صورت فراموشی
• Logout - خروج از حساب کاربری و ابطال توکن
• Check Token - چک کردن اعتبار توکن دریافت شده