لوگو

پنل کاربری

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"
}

توضیحات:

توضیحاتنوعنوعنام پارامتر
نام سازماناجباریStringsystemName
نام کاربریاجباریStringusername
رمز عبوراجباریStringpassword
همواره برابر webserviceاجباریStringscope
همواره برابر passwordاجباریStringgrant_type

دریافت پاسخ:

بدنه:

{
  "access_token": "ACCESS_TOKEN",
  "expires_in": EXPIRES_IN,
  "scope": "webservice",
  "userDetails": {USER_DETAILS}
}

توضیحات:

توضیحاتنوعنام پارامتر
توکن کاربرStringaccess_token
زمان انقضای توکن به ثانیهLongexpires_in
همواره برابر webserviceStringscope
اطلاعات کاربرObjectuserDetails

نکات:

1- در صورت لاگین مجدد قبل از منقضی شدن توکن، همان توکن قبلی به کاربر ارسال شده و زمان اعتبار آن ریست نمی‌شود.

2- زمان اعتبار توکن باید بر اساس مقدار برگردانده شده در این متد در نظر گرفته شود زیرا مقدار پیش‌فرض زمان اعتبار ممکن است تغییر کند.