ماژول RestAPI کامل Worksuite CRM – اتصال به تمامی سامانه ها

توضیحات

API Worksuite یک ابزار قدرتمند و انعطاف‌پذیر برای مدیریت خودکار و یکپارچه بخش‌های مختلف Worksuite CRM (نسخه 3.6.4 به بالا) است. این API به کسب‌وکارها اجازه می‌دهد تا فرآیندهای روزمره مثل مدیریت کارمندها، مشتریان، پروژه‌ها، امور مالی، و حتی اعلانات و رویدادها را به‌صورت برنامه‌ریزی‌شده و بدون نیاز به دخالت دستی انجام دهند. با استفاده از این API، می‌توانید Worksuite را به اپلیکیشن‌های موبایل، وبسایت‌ها، یا نرم‌افزارهای دیگر (مثل ابزارهای حسابداری یا مدیریت پروژه) متصل کنید و کارهایتان را ساده‌تر و سریع‌تر کنید.

این API از استاندارد REST استفاده می‌کند و داده‌ها را در قالب JSON منتقل می‌کند، که باعث می‌شود کار با آن برای توسعه‌دهندگان راحت باشد. برای دسترسی به قابلیت‌های API، باید ابتدا با ایمیل و رمز عبور یک رمز موقت (توکن) دریافت کنید، که مثل یک کلید امنیتی برای همه درخواست‌ها عمل می‌کند. Worksuite API به شما کمک می‌کند تا فرآیندهای کسب‌وکارتان را خودکار کنید، بهره‌وری را افزایش دهید و تجربه کاربری بهتری برای تیم و مشتریانتان فراهم کنید.

در ادامه، تمام قابلیت‌های API به‌صورت ساده و دسته‌بندی‌شده فهرست شده‌اند، همراه با یک مقدمه، توضیحات، و مثال‌هایی از کاربردهای واقعی آن.

---

لیست کامل قابلیت‌های API Worksuite

1. دسترسی با رمز موقت (Access Token)

• توضیح: برای استفاده از API، باید یک رمز موقت (توکن) بگیرید که از طریق ورود به سیستم ایجاد می‌شود. این رمز مثل یک کلید امنیتی برای دسترسی به همه قابلیت‌هاست.

2. مدیریت اپلیکیشن (App)

• دیدن اطلاعات اپلیکیشن (GET /app): اطلاعات کلی Worksuite مثل نسخه یا تنظیمات را ببینید.
• بررسی ماژول‌های خریداری‌شده (GET /purchased-module): لیست افزونه‌های خریداری‌شده (مثل ماژول HR یا مالی) را چک کنید.
• مدیریت زبان‌ها (GET /lang): زبان‌های پشتیبانی‌شده را ببینید یا زبان سیستم را تنظیم کنید.

3. احراز هویت (Auth)

• ورود به سیستم (POST /auth/login): با ایمیل و رمز عبور، رمز موقت بگیرید.
• تمدید رمز موقت (GET /auth/refresh): رمز موقت منقضی‌شده را تازه کنید.
• دیدن اطلاعات شرکت (GET /company): جزئیات شرکت (مثل نام یا لوگو) را ببینید.
• خروج از سیستم (POST /auth/logout): رمز موقت را غیرفعال کنید.

4. مدیریت مشتریان (Customers)

الف. سرنخ‌ها (Leads)

• دیدن لیست سرنخ‌ها (GET /lead): همه سرنخ‌ها (مشتری‌های بالقوه) را ببینید.
• دیدن جزئیات سرنخ (GET /lead/{id}): اطلاعات یک سرنخ خاص را چک کنید.
• اضافه کردن سرنخ جدید (POST /lead): سرنخ جدید اضافه کنید.
• ویرایش سرنخ (PUT /lead/{id}): اطلاعات سرنخ را تغییر دهید.
• حذف سرنخ (DEL /lead/{id}): سرنخ را پاک کنید.

ب. مشتریان (Clients)

• دیدن لیست مشتری‌ها (GET /client): همه مشتری‌ها را ببینید.
• دیدن جزئیات مشتری (GET /client/{id}): اطلاعات یک مشتری خاص را چک کنید.
• اضافه کردن مشتری جدید (POST /client): مشتری جدید اضافه کنید.
• ویرایش مشتری (PUT /client/{id}): اطلاعات مشتری را تغییر دهید.
• حذف مشتری (DEL /client/{id}): مشتری را پاک کنید.

5. منابع انسانی (HR)

الف. کارمندها (Employee)

• دیدن لیست کارمندها (GET /employee): همه کارمندها را ببینید.
• دیدن جزئیات کارمند (GET /employee/{id}): اطلاعات یک کارمند خاص را چک کنید.
• اضافه کردن کارمند جدید (POST /employee): کارمند جدید اضافه کنید.
• ویرایش کارمند (PUT /employee/{id}): اطلاعات کارمند را تغییر دهید.
• حذف کارمند (DEL /employee/{id}): کارمند را پاک کنید.

ب. دپارتمان‌ها (Department)

• دیدن لیست دپارتمان‌ها (GET /department): همه دپارتمان‌ها (مثل IT یا فروش) را ببینید.
• دیدن جزئیات دپارتمان (GET /department/{id}): اطلاعات یک دپارتمان خاص را چک کنید.
• اضافه کردن دپارتمان جدید (POST /department): دپارتمان جدید بسازید.
• ویرایش دپارتمان (PUT /department/{id}): اطلاعات دپارتمان را تغییر دهید.
• حذف دپارتمان (DEL /department/{id}): دپارتمان را پاک کنید.

ج. عناوین شغلی (Designation)

• دیدن لیست عناوین شغلی (GET /designation): همه عناوین شغلی (مثل مدیر یا برنامه‌نویس) را ببینید.
• دیدن جزئیات عنوان شغلی (GET /designation/{id}): اطلاعات یک عنوان شغلی خاص را چک کنید.
• اضافه کردن عنوان شغلی جدید (POST /designation): عنوان شغلی جدید بسازید.
• ویرایش عنوان شغلی (PUT /designation/{id}): اطلاعات عنوان شغلی را تغییر دهید.
• حذف عنوان شغلی (DEL /designation/{id}): عنوان شغلی را پاک کنید.

د. تعطیلات (Holiday)

• دیدن لیست تعطیلات (GET /holiday): همه تعطیلات شرکت را ببینید.
• دیدن جزئیات تعطیلی (GET /holiday/{id}): اطلاعات یک تعطیلی خاص را چک کنید.
• اضافه کردن تعطیلی جدید (POST /holiday): تعطیلی جدید اضافه کنید.
• ویرایش تعطیلی (PUT /holiday/{id}): اطلاعات تعطیلی را تغییر دهید.
• حذف تعطیلی (DEL /holiday/{id}): تعطیلی را پاک کنید.

6. کارها و پروژه‌ها (Work)

الف. پروژه‌ها (Projects)

• دیدن لیست پروژه‌ها (GET /project): همه پروژه‌ها را ببینید.
• دیدن اعضای پروژه (GET /project/{id}/members): کارمندهای یک پروژه خاص را چک کنید.
• دیدن جزئیات پروژه (GET /project/{id}): اطلاعات یک پروژه خاص را ببینید.
• دیدن وظایف پروژه (GET /tasks): وظایف پروژه‌ها را ببینید.
• اضافه کردن پروژه جدید (POST /project): پروژه جدید بسازید.
• ویرایش پروژه (PUT /project/{id}): اطلاعات پروژه را تغییر دهید.
• حذف پروژه (DEL /project/{id}): پروژه را پاک کنید.

ب. وظایف (Task)

• دیدن لیست وظایف (GET /task): همه وظایف را ببینید.
• دیدن جزئیات وظیفه (GET /task/{id}): اطلاعات یک وظیفه خاص را چک کنید.
• دیدن زیروظایف (GET /task/{id}/subtasks): زیروظایف یک وظیفه را ببینید.
• دیدن جزئیات زیروظیفه (GET /task/{id}/subtasks/{id}): اطلاعات یک زیروظیفه خاص را چک کنید.
• اضافه کردن وظیفه جدید (POST /task): وظیفه جدید بسازید.
• ویرایش وظیفه (PUT /task/{id}): اطلاعات وظیفه را تغییر دهید.
• حذف وظیفه (DEL /task/{id}): وظیفه را پاک کنید.

ج. قراردادها (Contract)

انواع قرارداد (Contract Types)

• دیدن لیست انواع قرارداد (GET /contract-type): همه انواع قرارداد را ببینید.
• دیدن جزئیات نوع قرارداد (GET /contract-type/{id}): اطلاعات یک نوع قرارداد را چک کنید.
• اضافه کردن نوع قرارداد جدید (POST /contract-type): نوع قرارداد جدید بسازید.
• ویرایش نوع قرارداد (PUT /contract-type/{id}): اطلاعات نوع قرارداد را تغییر دهید.
• حذف نوع قرارداد (DEL /contract-type/{id}): نوع قرارداد را پاک کنید.

قراردادها (Contract)

• دیدن لیست قراردادها (GET /contract): همه قراردادها را ببینید.
• اضافه کردن قرارداد جدید (POST /contract): قرارداد جدید بسازید.
• دیدن جزئیات قرارداد (GET /contract/{id}): اطلاعات یک قرارداد خاص را چک کنید.
• ویرایش قرارداد (PUT /contract/{id}): اطلاعات قرارداد را تغییر دهید.
• حذف قرارداد (DEL /contract/{id}): قرارداد را پاک کنید.

7. مالی (Finance)

الف. برآوردها (Estimate)

• دیدن لیست برآوردها (GET /estimate): همه برآوردهای هزینه را ببینید.
• دیدن جزئیات برآورد (GET /estimate/{id}): اطلاعات یک برآورد خاص را چک کنید.
• اضافه کردن برآورد جدید (POST /estimate): برآورد جدید بسازید.
• ویرایش برآورد (PUT /estimate/{id}): اطلاعات برآورد را تغییر دهید.
• حذف برآورد (DEL /estimate/{id}): برآورد را پاک کنید.

ب. فاکتورها (Invoice)

• دیدن لیست فاکتورها (GET /invoice): همه فاکتورها را ببینید.
• دیدن جزئیات فاکتور (GET /invoice/{id}): اطلاعات یک فاکتور خاص را چک کنید.
• اضافه کردن فاکتور جدید (POST /invoice): فاکتور جدید بسازید.
• ویرایش فاکتور (PUT /invoice/{id}): اطلاعات فاکتور را تغییر دهید.
• حذف فاکتور (DEL /invoice/{id}): فاکتور را پاک کنید.

8. تابلوی اعلانات (Notice Board)

• دیدن لیست اعلانات (GET /notice): همه اطلاعیه‌های شرکت را ببینید.
• دیدن جزئیات اعلان (GET /notice/{id}): محتوای یک اعلان خاص را چک کنید.
• ساخت اعلان جدید (POST /notice): اطلاعیه جدید بسازید.
• ویرایش اعلان (PUT /notice/{id}): اطلاعات اعلان را تغییر دهید.
• حذف اعلان (DEL /notice/{id}): اعلان را پاک کنید.

9. رویدادها (Event)

• دیدن لیست رویدادها (GET /event): همه رویدادهای شرکت را ببینید.
• دیدن جزئیات رویداد (GET /event/{id}): اطلاعات یک رویداد خاص را چک کنید.
• ساخت رویداد جدید (POST /event): رویداد جدید بسازید.
• ویرایش رویداد (PUT /event/{id}): اطلاعات رویداد را تغییر دهید.
• حذف رویداد (DEL /event/{id}): رویداد را پاک کنید.

10. محصولات (Product)

• دیدن لیست محصولات (GET /product): همه محصولات یا خدمات را ببینید.
• دیدن جزئیات محصول (GET /product/{id}): اطلاعات یک محصول خاص را چک کنید.
• اضافه کردن محصول جدید (POST /product): محصول یا خدمت جدید بسازید.
• ویرایش محصول (PUT /product/{id}): اطلاعات محصول را تغییر دهید.
• حذف محصول (DEL /product/{id}): محصول را پاک کنید.

11. حضور و غیاب (Attendance)

• ثبت ورود (POST /attendance/clock-in): زمان ورود کارمند را ثبت کنید.
• ثبت خروج (POST /attendance/clock-out): زمان خروج کارمند را ثبت کنید.
• بررسی حضور و غیاب روزانه (GET /attendance/today): گزارش حضور و غیاب روز را ببینید.

---

کاربردهای واقعی API Worksuite (مثال‌ها)

اپلیکیشن موبایل برای حضور و غیاب:

• • سناریو: یه شرکت می‌خواد کارمندها بتونن از طریق یه اپ موبایل ورود و خروجشون رو ثبت کنن.
  • چطور؟: با استفاده از /attendance/clock-in و /attendance/clock-out، اپلیکیشن می‌تونه زمان ورود و خروج رو ثبت کنه. با /attendance/today هم مدیر می‌تونه گزارش روزانه حضور و غیاب رو تو گوشی ببینه.
  • فایده: کارمندها نیازی به دستگاه حضور و غیاب فیزیکی ندارن و مدیر می‌تونه از هرجا گزارش‌ها رو چک کنه.

فرم وب برای جمع‌آوری سرنخ:

• • سناریو: یه وبسایت دارین که بازدیدکننده‌ها می‌تونن فرم تماس پر کنن تا به‌عنوان سرنخ ثبت بشن.
  • چطور؟: فرم وب با /lead اطلاعات (مثل اسم و شماره تماس) رو مستقیم به Worksuite می‌فرسته و سرنخ جدید ثبت می‌شه.
  • فایده: تیم فروش می‌تونه سریع سرنخ‌ها رو پیگیری کنه بدون اینکه نیاز باشه اطلاعات رو دستی وارد سیستم کنن.

اتوماسیون فاکتورها با نرم‌افزار حسابداری:

• • سناریو: شرکت شما از یه نرم‌افزار حسابداری مثل QuickBooks استفاده می‌کنه و می‌خواد فاکتورهای Worksuite رو باهاش سینک کنه.
  • چطور؟: با /invoice می‌تونید فاکتور جدید بسازید یا با /invoice/{id} اطلاعات فاکتورها رو به نرم‌افزار حسابداری منتقل کنید.
  • فایده: حسابداری سریع‌تر و دقیق‌تر می‌شه و خطای انسانی کم می‌شه.

ارسال اعلان خودکار به تیم:

• • سناریو: وقتی پروژه جدیدی شروع می‌شه، می‌خواید یه اعلان خودکار برای تیم بفرستید.
  • چطور؟: با /notice می‌تونید یه اعلان جدید بسازید که مثلاً بگه “پروژه X شروع شد، لطفاً وظایفتون رو چک کنید.”
  • فایده: تیم سریع مطلع می‌شه و هماهنگی بهتری بین اعضا ایجاد می‌شه.

مدیریت پروژه‌ها از یه داشبورد خارجی:

• • سناریو: یه داشبورد سفارشی دارین که می‌خواد پروژه‌ها و وظایف Worksuite رو نشون بده.
  • چطور؟: با /project و /task می‌تونید لیست پروژه‌ها و وظایف رو بکشید و تو داشبورد نمایش بدید. با /project/{id}/members هم می‌تونید ببینید کی تو پروژه کار می‌کنه.
  • فایده: مدیرها می‌تونن همه‌چیز رو از یه جا مدیریت کنن بدون نیاز به ورود به Worksuite.

تقویم رویدادها تو اپ موبایل:

• • سناریو: می‌خواید کارمندها رویدادهای شرکت (مثل جلسات) رو تو یه اپ موبایل ببینن.
  • چطور؟: با /event لیست رویدادها رو می‌گیرید و تو اپ نمایش می‌دید. با /event/{id} هم جزئیات هر رویداد رو نشون می‌دید.
  • فایده: کارمندها همیشه از رویدادها باخبرن و می‌تونن برنامه‌ریزی بهتری داشته باشن.

مدیریت محصولات تو وبسایت فروش:

• • سناریو: یه وبسایت فروش دارین و می‌خواید محصولات Worksuite رو توش نمایش بدید.
  • چطور؟: با /product لیست محصولات رو می‌گیرید و تو وبسایت نشون می‌دید. با /product/{id} هم جزئیات هر محصول رو نمایش می‌دید.
  • فایده: محصولات همیشه به‌روزن و مشتری‌ها می‌تونن مستقیم از وبسایت خرید کنن.

---

نکات مهم

• نیاز به رمز موقت: برای همه درخواست‌ها (به‌جز ورود)، باید رمز موقت از /auth/login بگیرید.
• نیازمندی سیستم: Worksuite CRM نسخه 3.6.4 یا بالاتر لازمه.
• اتصال به سیستم‌های دیگه: این API به شما اجازه می‌ده Worksuite رو با هر سیستمی (مثل اپ موبایل، وبسایت، یا نرم‌افزارهای مدیریت) ادغام کنید.
• مستندات کامل: برای جزئیات بیشتر (مثل پارامترها یا نمونه پاسخ‌ها)، به مستندات Postman (https://documenter.getpostman.com/view/147520/2sA3kPq5NZ) مراجعه کنید.

جمع‌بندی

API Worksuite یه ابزار همه‌کاره برای خودکارسازی و یکپارچه‌سازی فرآیندهای کسب‌وکاره. از مدیریت کارمندها و مشتریان گرفته تا پروژه‌ها، امور مالی، و رویدادها، این API به شما کمک می‌کنه تا وقت و انرژی‌تون رو ذخیره کنید و بهره‌وری تیم‌تون رو بالا ببرید. با کاربردهای متنوعش، می‌تونید Worksuite رو به هر سیستمی که دوست دارید وصل کنید و تجربه‌ای ساده‌تر و سریع‌تر برای خودتون و مشتری‌هاتون بسازید.