راهنمای کامل وب سرویس نرم افزار هما

مدیر فنی پنج‌شنبه 1400/11/14

راهنمای پیاده سازی رابط نرم افزاری

وب سرویس و API

نرم افزار حسابداری تحت وب هُما

 

لطفا برای دسترسی به سرویس API پیامدهی از اینجا به مطالعه ادامه دهید : راهنمای وب سرویس پیامدهی هما

 

مقدمه

سرویس برنامه نویسی نرم افزار هما(ای پی آی API) یک ابزار جامع و کارآمد برای ارتباط بین هما و سایر سیستم های اطلاعاتی است. این مجموعه سرویس به منظور هماهنگ سازی، گزارشگیری و برخی موارد دیگر مابین سیستمهای اطلاعاتی مختلف با سیستم هُما کاربرد دارد. این سرویسها در سطح پایه طراحی شده و صرفا جهت رفع نیازهای ارتباطی اصلی مابین سیستمهای اطلاعاتی کاربرد خواهند داشت که موارد ذیل را پوشش میدهند:

کانتکت ها

کالاها و خدمات

فاکتورها

انبارداری پایه

محتوای متنی سیستم هما (Html Editor) و CMS

 

معرفی

وب سرویس محتوای عمومی هما، به منظور ارتباط اولیه و گزارشگیری ساده ی نرم افزار هما با سایر سیستمهای اطلاعاتی، وبسایتها، اپلیکیشن های موبایل-تبلت و سایر نرم افزارها طراحی شده است. این سرویس به منظور تامین موارد متعدد کاربرد دارد که در این باب به تفصیل نکات مرتبط بیان خواهد شد.

 

دسترسی به سرویس

https://dev.homais.com/Content/

توصیه مهم

استفاده از وب سرویس نرم افزار حسابداری تحت وب هما، نیازمند یک دسترسی مجزا به نرمافزار هما دارید. با توجه به اینکه هر عملیات مجزا توسط شناسه کاربری درخواست کننده(اعم از وب سرویس و یا کاربر نرم افزار) کدگذاری شده و بطور مجزا نگهداری می شود، توصیه می شود کاربِر وبسرویس، همزمان از پنل کاربری نرم افزار هما استفاده عمومی نداشته باشد.

 

انواع داده ای و کدهای بازگشتی سرویس‌ها

شرح انواع داده ای(کلاسهای بازگشتی و غیره) در ضمیمه شماره "1" و جداول کدهای بازگشتی در ضمیمه شمره "2" آورده شده است.

 

بخش اول. انبارداری پایه

 

عملکرد سرویس

1 .بروزرسانی موجودی انبار در نرم افزار هما: به روش "درج کارکدکس کالا در انبار" (ورود/خروج کلا) به تفکیک کالا و رده بندی.

2 .استعلام موجودی لحظه ای انبار در هما: به ازای یک کالای خاص و حتی در یک ردهبندی خاص.

 

متدهای وب سرویس انبارداری

1. warehouse_addlog (output as res_content)

2. wiki_loadCategorylist (output as dataTable)

 

معرفی و شرح متدها :

1. warehouse_addlog

این متد به ازای هر کالا و رده بندی، یک رویداد ورود/خروج را در انبار ثبت می کند که بر موجودی لحظه ای کالاها تاثیر گذاشته و اثری قابل ردیابی در سیستم به جای خواهد گذاشت. متد مذکور نیازمند پارامترهای ورودی ذیل است:

 

کد اشتراک :portalcode: Integer

نام کاربری :Username: String

کلمه عبور :Password: String

توسط سیستم داده خواهد شد شناسه کالا :wareID: Long

بندی مورد نظر- توسط سیستم داده خواهد شد شناسه رده :wareCategory: Long

میزان ورودی به انبار :inputAmount: float/Double

میزان خروجی از انبار :outputAmount: float/Double

شناسه مقیاس مورد نظر :scaleID: Long

 

 

2. warehouse_checkbalance

به منظور دستیابی به موجودی لحظه ای کالا در کل انبارهای نرم افزار هما، و یا در یک رده بندی خاص از این متد استفاده کنید. مقدار بازگشتی این متد یک عدد اعشاری و بیانگر موجودی دقیق لحظه ای کالا است. در صورتی که پارامتر categoryID را با مقدار "صفر" مقداردهی کنیم، مقدار موجودی کالا بازگردانده خواهد شد و اگر شناسه خاص رده بندی مورد نظر را وارد کنیم، مقدار موجودی کالا در آن رده خاص بازگردانده خواهد شد.

کد اشتراک :Portalcode: Integer

نام کاربری :Username: String

کلمه عبور :Password: String

شناسه کالا- توسط سیستم ایجاد خواهد شد :wareID: Long

شناسه رده بندی مورد نظر-توسط سیستم ایجاد می شود :categoryID: Long

 

 

 

 

بخش دوم. فاکتورها

 

عملکرد سرویس

1 ..ثبت انواع فاکتور جدید(فروش، خرید، انواع فاکتور برگشتی و رسمی)

2 .حذف و اضافه آیتمهای فاکتور

3. تائید و بستن فاکتور

4. .ویرایش فیلدهای فاکتور که شامل موارد ذیل است:

4.1 سریال فاکتور

4.2 طرف حساب

4.3 تاریخ

4.4 رفرنس(سریال جانبی فاکتورها)

4.5 تخفیفات

4.6 رُند فاکتور

5. تغییر وضعیت فاکتور به: تحت ویرایش، نهائی(آماده پرداخت)، پرداخت ناقص و یا تسویه شده

6. حذف فاکتور

7. بارگذاری بدنه فاکتور

8. .بارگذاری لیست آیتمهای فاکتور

 

متدهای وب سرویس فاکتورها

1. invoice_bodyEntry (output as res_content)

2. invoice_itemEntry (output as res_content)

3. invoice_loadBody (output as dataTable)

4. invoice_loadList (output as dataTable)

 

 

 

 

 

 

 

این مطلب در حال تدوین است ...