gettoken

مجوز و ورود به سیستم

کدی را به برنامه خارجی که URL زیر را با استفاده از روش POST فراخوانی می کند اضافه کنید:

http://{pm-server}/{workspace}/oauth2/token

برای دریافت مجوز از OAuth2.0 و وارد شدن به ProcessMaker، شی POST زیر را با اعتبارنامه ارسال کنید:

ورودی:

عنصر	شرح
{	شروع شی.
"grant_type": "رمز عبور"،	نوع کمک هزینه، که می تواند `"password"`یا `"authorization_code"`.
"scope: "{scope}",	محدوده ای که تعیین می کند به کدام نقاط پایانی می توان دسترسی داشت: `"*"`(همه دامنه ها)، `"edit_process"`(دسترسی به نقاط پایانی برای تغییر فرآیندها)، `"view_process"`(دسترسی به نقاط پایانی برای مشاهده اما نه تغییر فرآیندها).
"client_id": "{code}"،	کد شناسه مشتری که هنگام ثبت درخواست داده شده است.
"client_secret":"{code}"،	کد مخفی مشتری که هنگام ثبت درخواست داده شده است.
"username": "{username}",	نام کاربری یک کاربر ProcessMaker که به حروف بزرگ و کوچک حساس نیست.
"password": "{password}"	رمز عبور یک کاربر ProcessMaker.
}	شیء پایانی

خروجی:

اگر یک access_token اعطا شد، کد وضعیت HTTP روی 200 تنظیم می شود (موفقیت) و شی JSON زیر برگردانده می شود:

عنصر	شرح
{	شروع شی بازگشت.
"access_token": "{code}"،	نشانه دسترسی که در هدر تماس های REST بعدی ارسال می شود.
"expires_in": {sec}،	تعداد ثانیه تا انقضای access_token. به طور پیش فرض 86400 است.
"token_type": "حامل"،	نوع توکنی که همیشه "حامل" است، به این معنی که هر درخواستی که از access_token استفاده می کند معتبر تلقی می شود و نیازی به تایید بیشتر نیست. ProcessMaker از نوع رمز "mac" پشتیبانی نمی کند که به رمز عبور رمزگذاری شده نیاز دارد.
"scope": "{scope}",	محدوده دسترسی REST.
"refresh_token":"{code}"	نشانه رفرش که برای به دست آوردن یک access_token دیگر در زمانی که مورد فعلی منقضی می شود استفاده می شود.
}	پایان شی بازگشت.

اگر خطایی رخ داده باشد، کد وضعیت HTTP روی تنظیم می شود 200و یک شی خطا مانند زیر برگردانده می شود:

{
"error" : "invalid_client" ,
"error_description" : "اعتبارنامه مشتری نامعتبر است"
}