لیست api
مقدمه راهنمای api
مقدمه راهنمای api
برای اینکه بتوان api ها را فراخوانی کرد، باید از طریق OAuth لاگین شد و token دریافت کرد
هر کاربر بر اساس token که دریافت می کند دسترسی های تعریف شده خود را داراست.
در سیستم اصلی هنگام لاگین کاربر token دریافت می شود .
دو نوع token مورد نیاز است
1- token کاربر:برای انجام کارهای مرتبط با کاربر مثل اقدام روی وظایف و ...
2- token ادمین:برای انجام کارهایی که دسترسی ادمین نیاز دارد مثل : ایجاد کاربر جدید- ایجاد پست جدید و...
ورودی:
عنصر | شرح | مثال |
---|---|---|
{ | شروع شی. | |
"grant_type": "رمز عبور"، | نوع کمک هزینه، که می تواند "password" یا "authorization_code" . |
|
"scope: "{scope}", | دامنه ای که تعیین می کند به کدام نقاط پایانی می توان دسترسی داشت: | |
"client_id": "{code}"، | کد شناسه مشتری که هنگام ثبت درخواست داده شده است. | |
"client_secret":"{code}"، | کد مخفی مشتری که هنگام ثبت درخواست داده شده است. | |
"username": "{username}", | نام کاربری یک کاربر ProcessMaker که به حروف بزرگ و کوچک حساس نیست. | |
"password": "{password}" | رمز عبور یک کاربر ProcessMaker. | |
} | شیء پایانی |
خروجی:
عنصر | شرح | |
---|---|---|
{ | شروع شی بازگشت. | |
"access_token": "{code}"، | نشانه دسترسی که در هدر تماس های REST بعدی ارسال می شود. | |
"expires_in": {sec}، | تعداد ثانیه تا انقضای access_token. به طور پیش فرض 86400 است. | |
"token_type": "حامل"، | نوع توکنی که همیشه "حامل" است، | |
"scope": "{scope}", | محدوده دسترسی REST. | |
"refresh_token":"{code}" | نشانه رفرش که برای بدست آوردن access_token دیگری در زمان منقضی شدن علامت فعلی استفاده می شود. | |
} | پایان شی بازگشت. |