پنل کاربری
1- احراز هویت
ورود به سیستم
احراز هویت و دریافت توکن دسترسی با استفاده از پروتکل OAuth2 این توکن برای دسترسی به سایر متدهای وبسرویس ضروری است.
آدرس:auth/oauth/token
متد:POST
فراخوانی درخواست:
هدر:
نمونه | توضیحات | نوع | نام پارامتر |
---|---|---|---|
Basic c21zUGFuZWxDbGdcaW52AC | برای دریافت Client ID و Client Secret، با حساب ادمین سازمان وارد پنل شوید و از بخش "پروفایل من" آنها را ایجاد کنید. | اجباری | Authorization |
بدنه:
{ "systemName": "SYSTEM_NAME", "username": "USERNAME", "password": "PASSWORD", "scope": "webservice", "grant_type": "password" }
توضیحات:
توضیحات | نوع | نوع | نام پارامتر |
---|---|---|---|
نام سازمان | اجباری | String | systemName |
نام کاربری | اجباری | String | username |
رمز عبور | اجباری | String | password |
همواره برابر webservice | اجباری | String | scope |
همواره برابر password | اجباری | String | grant_type |
دریافت پاسخ:
بدنه:
{ "access_token": "ACCESS_TOKEN", "expires_in": EXPIRES_IN, "scope": "webservice", "userDetails": {USER_DETAILS} }
توضیحات:
توضیحات | نوع | نام پارامتر |
---|---|---|
توکن کاربر | String | access_token |
زمان انقضای توکن به ثانیه | Long | expires_in |
همواره برابر webservice | String | scope |
اطلاعات کاربر | Object | userDetails |
نکات:
1- در صورت لاگین مجدد قبل از منقضی شدن توکن، همان توکن قبلی به کاربر ارسال شده و زمان اعتبار آن ریست نمیشود.
2- زمان اعتبار توکن باید بر اساس مقدار برگردانده شده در این متد در نظر گرفته شود زیرا مقدار پیشفرض زمان اعتبار ممکن است تغییر کند.