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

توضیحات

معرفی ماژول RestAPI کامل Worksuite CRM

آیا تا به حال کلافه شده‌اید که چرا نرم‌افزار حسابداری شما اطلاعات مشتریان را از سیستم مدیریت ارتباط با مشتری نمی‌خواند و مجبورید همه‌چیز را دوباره تایپ کنید؟ این دقیقا همان جایی است که ماژول RestAPI به عنوان یک ناجی قدرتمند وارد عمل می‌شود تا تمام نرم‌افزارهای شرکت شما را به یکدیگر متصل کند. در این مطلب قرار است نحوه عملکرد، امنیت، کاربردهای شگفت‌انگیز و مراحل راه‌اندازی این ابزار بی‌نظیر را بررسی کنیم؛ با ما همراه باشید!

API Worksuite چیست؟

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

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

تجربه یکی از مشتریان سابق ما درباره RestAPI به شرح زیر است:

« قبل از اینکه ماژول RestAPI رو روی سیستممون فعال کنیم، بچه‌های تیم فروش مجبور بودن هر روز لیست فرم‌های تماس رو از سایت خروجی بگیرن و دستی تو ورک سوییت وارد کنن. قشنگ روزی یکی دو ساعت وقتمون سر این کار روتین هدر می‌رفت و پر از سوتی‌های تایپی بودیم! اما از وقتی که سایتمون رو با کمک ماژول RestAPI به سیستم CRM وصل کردیم، هر کسی که تو سایت فرم پر می‌کنه، همون لحظه مستقیم تو پنل به عنوان سرنخ جدید ثبت می‌شه و یه تسک پیگیری هم برای کارشناس فروش میاد!»

لیست کامل قابلیت‌های 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 گزارش روزانه حضور و غیاب را مستقیما در تلفن همراه خود مشاهده کنند.
• مزایا: عدم نیاز به دستگاه‌های حضور و غیاب فیزیکی و امکان بررسی لحظه‌ای گزارش‌ها توسط مدیران از هر مکان

۲. فرم‌های تحت وب برای جمع‌آوری و ثبت سرنخ‌ها (Leads)

• سناریو: سازمانی دارای یک وب‌سایت است که بازدیدکنندگان از طریق تکمیل فرم تماس، اطلاعات خود را جهت دریافت خدمات ثبت می‌کنند.
• نحوه اجرای فرآیند: فرم وب با استفاده از مسیر /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 مراجعه کنید.

حرف آخر

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