مستندات نحوه ارتباط با API:
آخرین به روز رسانی:
در صورتی که افزونه APi بر روی برنامه شما فعال نیست می توانید از طریق صفحه خرید آنلاین خریداری نمایید و در همان لحظه این افزونه در برنامه ی شما فعال می شود.
فعال سازی سرویس API در برنامه ته حساب:
برای راه اندازی وب سرویس، در برنامه ی ته حساب، منوی پرونده، گزینه ی APi را انتخاب نمایید و فقط فعال سازی APi را انتخاب نمایید.
برای تست ابتدا به صورت Local بررسی نمایید، درصورتی که صفحه “وب سرویس فعال می باشد” در مرورگر باز شد، از طریق اینترنت تست خود را انجام دهید، در صورت بروز مشکل، Port forwading، آی پی استاتیک و فایروال را بررسی نمایید.
برای فعال بودن سرویس API، باید برنامه ی ته حساب بر روی سیستم اصلی باز باشد ولی نیازی نیست ورود به برنامه انجام شود.
ارسال کد توکن جهت افزایش امنیت: (Authorization)
در Authorization Bearer توکن ساخته شده در بخش تنظیمات API در برنامه ارسال شود. در صورتی که توکن به درستی ارسال نشود با این پیغام مواجه می شوید: Unsupported authorization scheme.
برای مثال: (cURL)
–header ‘Authorization: Bearer C1X4Y8L3W2B1B8P4W7F7O5H8U4D5U7X6Q5L3P6U3T2Q5G2N7J6Y4T4W5U7H6U2A8Y7F2X5X5T2M2V7A2’ \
اتصال به محیط های مختلف: (Header)
جهت اتصال به محیط مورد نظر در بخش Header، نام محیط را در کلید DBName ارسال نمایید:
برای مثال: (cURL)
–header ‘DBName: DB’ \
برای بانک اطلاعاتی اکسس، نام فولدر محیط ارسال شود: DB1 محیط یک، DB محیط اصلی
برای بانک اطلاعاتی SQL Server، نام دیتابیس محیط ارسال شود: TahesabDB1 محیط یک، TahesabDB محیط اصلی
توضیح پارامتر های ارسالی: (Body)
- لطفا به کارکتر ” ” (String یا عدد بودن) دقت داشته باشید.
- در پارامتر
Sabte_Kol_Or_Movaghat_0_1
اگر عدد ۱ ارسال شود سند ثبت کل می شود، اگر ۰ ارسال شود سند به شکل موقت ثبت می شود و در بخش اسناد موقت قابل رویت می باشد. - در پارامتر
MazanehIsMesghalOrGeram_0_1
اگر عدد ۰ ارسال شود مزنه هر مثقال می باشد و اگر ۱ ارسال شود هر گرم می باشد. - در پارامتر
IsMotefaregheOrAbshode_0_1
اگر عدد ۰ ارسال شود متفرقه و ۱ آبشده می باشد. - در پارامتر
IsVoroodOrKhorooj_0_1
اگر ۰ وارد شود نوع سند دریافتی/ورود و اگر ۱ وارد شود پرداختی/خروج می باشد. - در پارامتر
BuyOrSale_0_1
اگر عدد ۱ ارسال شود نوع سند خرید و اگر ۰ ارسال شود نوع سند فروش می باشد. - پارامتر
Radif_Number
عدد ۱ ارسال شود. - در صورتی که
IsMotefaregheOrAbshode_0_1
عدد ۱ ارسال شده است بایدAng_Number
وName_az
مقدار داشته باشند. - پارامتر
Name_az
به معنای نام آزمایشگاه می باشد. - پارامتر
Ang_Number
به معنای شماره انگ می باشد. - در ارسال مقادیر تاریخ، اعداد بدون صفر در ابتدا وارد شوند برای مثال برای ارسال ماه اردیبهشت، عدد ۰۲ ارسال نشود، ۲ ارسال شود.
- پارامتر Darsad_Maliat به معنای عدد درصد مالیات می باشد. که عدد ۹ ارسال می شود.
- در پارامتر OjratTedadiOrGerami_0_1 اگر اجرت را کل یک عدد را وارد کردیم عدد ۰ و اگر اجرت هر گرم را وارد کردیم عدد ۱ ارسال شود.
- در پارامتر MeghdarMaliat مقدار محاسبه شده ی کل مالیات وارد شود.
- در پارامتر PictureFileName نام فایل تصویر وارد شود. برای مثال a1.jpg
- در پارامتر IsMarjoo_1_0 اگر کالا مرجوع شده است عدد ۱ و اگر مرجوعی نمی باشد عدد صفر ارسال شود.
- در پارامتر Darsad_Sood عدد درصد سود وارد شود. برای مثال عدد ۷ ارسال شود به معنای هفت درصد سود
نکات مهم:
- فرمت آدرس URL به این شکل می باشد:
- در حالت LOCAL: https://127.0.0.1:8081/
- یا به آدرس آی پی اختصاصی شما (استاتیک):
- برای مثال: https://5.12.34.56:8081/
- آدرس URL دارای Endpoint نمی باشد.
- درخواست ها حتما به HTTPS ارسال شود.
- در صورتی که در برنامه ی POSTMAN با خطای Valid نبودن SSL مواجه شدید، در بخش تنظیمات POSTMAN گزینه ی SSL Certificate verification رو خاموش نمایید.
- از متد POST استفاده نمایید.
- تاریخ ها شمسی می باشد.
- قالب تمامی درخواست ها و پاسخ ها، JSON می باشد.
لیست دستور ها: (Body)
(در قالب JSON در Body ارسال شود)
RFID
ارسال لیست تگ های RFID خوانده شده:
{"epcList":["E123456789123456", "E123456789123457","E123456789123458"]}
دریافت مشخصات تگ RFID:
{"GetInfo":[
, "E123456789123456"
"E123456789123457"]}
دریافت مشخصات تگ RFID (با تصویر):
{"GetInfoWithImage":["E123456789123456", "E123456789123457"]}
حساب ها و مشتریان
دریافت آخرین مانده حساب و تفکیک ته حساب چند مشتری همزمان:
{"getmandehesabbycode":["1","2","3"]}
دریافت مانده حساب و تفکیک ته حساب یک مشتری در تاریخ مشخص:
{"GetMandeHesabByTarikh":["1","1403-08-06"]}
ثبت مشتری، حساب جدید:
{"DoNewMoshtari":["Name","GroupName","Tel","Address"]}
لیست مشتری، حساب ها: (از کد حساب تا کد حساب)
{"DoListMoshtari":[From_Code,To_Code]}
لیست مشتری، حساب ها: (فیلتر بر اساس شماره تلفن)
{"DoListMoshtari":[Tel]}
شماره موبایل بدون صفر وارد شود
آبشده و متفرقه
ثبت سند ورود و خروج آبشده و متفرقه:
{"DoNewSanadVKHGOLD":[Sabte_Kol_Or_Movaghat_1_0, Moshtari_Code, Factor_Number, Radif_Number, Shamsi_Year, Shamsi_Month, Shamsi_Day, Vazn, Ayar, Ang_Number, "Name_az", IsVoroodOrKhorooj_0_1, IsMotefaregheOrAbshode_0_1]}
ثبت سند خرید و فروش آبشده و متفرقه:
{"DoNewSanadBuySaleGOLD":[Sabte_Kol_Or_Movaghat_1_0, Moshtari_Code, Factor_Number, Radif_Number, Shamsi_Year, Shamsi_Month, Shamsi_Day, Vazn, Ayar, 0, "", BuyOrSale_0_1, Mazaneh, MazanehIsMesghalOrGeram_0_1, IsMotefaregheOrAbshode_0_1, MablaghKol]}
سکه
ثبت سند ورود و خروج سکه:
{"DoNewSanadVKHSEKEH":[Sabte_Kol_Or_Movaghat_1_0, Moshtari_Code, Factor_Number, Radif_Number, Shamsi_Year, Shamsi_Month, Shamsi_Day, Vazn, Ayar, Count, "Name_Sekeh", IsVoroodOrKhorooj_0_1]}
ثبت سند خرید و فروش سکه:
{"DoNewSanadBuySaleSEKEH":[Sabte_Kol_Or_Movaghat_1_0, Moshtari_Code, Factor_Number, Radif_Number, Shamsi_Year, Shamsi_Month, Shamsi_Day, Vazn, Ayar, Count, Name_Sekeh, BuyOrSale_0_1, Mazaneh, MablaghKol]}
مالی
ثبت سند ورود و خروج وجه نقد:
{"DoNewSanadVKHVaghNaghd":[Sabte_Kol_Or_Movaghat_1_0, Moshtari_Code, Factor_Number, Radif_Number, Shamsi_Year, Shamsi_Month, Shamsi_Day, IsVoroodOrKhorooj_0_1, Mablagh, "Sharh"]}
ثبت سند تخفیف ما به مشتری و مشتری به ما:
{"DoNewSanadTakhfif":[Sabte_Kol_Or_Movaghat_1_0, Moshtari_Code, Factor_Number, Radif_Number, Shamsi_Year, Shamsi_Month, Shamsi_Day, IsMaBeMoshtariOrMoshtariBeMa_0_1, Mablagh, "Sharh"]}
ثبت سند طلب ما و بدهی ما:
{"DoNewSanadTalabBedehi":[Sabte_Kol_Or_Movaghat_1_0, Moshtari_Code, Factor_Number, Radif_Number, Shamsi_Year, Shamsi_Month, Shamsi_Day, IsBedehiOrTalab_0_1, Mablagh, "Sharh", Baabat, Vazn]}
کارساخته
ثبت سند خرید و فروش کارساخته:
{"DoNewSanadBuySaleKar":[1Sabte_Kol_Or_Movaghat_1_0, 2Moshtari_Code, 3Factor_Number, 4Radif_Number, 5Shamsi_Year, 6Shamsi_Month, 7Shamsi_Day, 8Vazn, 9Ayar, 10Count, 11"Name_Kar", 12BuyOrSale_0_1, 13Mazaneh, 14MazanehIsMesghalOrGeram_0_1, 15MablaghKol, 16OjratTedadiOrGerami_0_1, 17Darsad_Maliat, 18MeghdarMaliat, 19Darsad_Sood, 20Darsad_Talayee, 21IsMarjoo_1_0, 22PoolSang, 23"PictureFileName", 24Ojrat]}
ثبت سند ورود و خروج کارساخته:
{"DoNewSanadVKHKar":[1Sabte_Kol_Or_Movaghat_1_0, 2Moshtari_Code, 3Factor_Number, 4Radif_Number, 5Shamsi_Year, 6Shamsi_Month, 7Shamsi_Day, 8Vazn, 9Ayar, 10Count, 11"Name_Kar", 12IsVoroodOrKhorooj_0_1, 13OjratTedadiOrGerami_0_1, 14MablaghKol, 15Darsad_Maliat, 16MeghdarMaliat, 17Darsad_Talayee, 18IsMarjoo_1_0, 19"PictureFileName", 20Ojrat, 21PoolSang]}
اتیکت
دریافت مشخصات اتیکت از طریق شناسه ی کار:
{"getetiketinfobycode":["1","2","3"]}
دریافت مشخصات اتیکت از طریق شناسه ی کار با تصویر:
{"getetiketinfobycodewithimage":["1","2","3"]}
لیست اتیکت ها: (از شناسه کار تا شناسه کار)
{"DoListEtiket":[From_Code, To_Code, WithPhoto_1_0]}
WithPhoto
: درصورتی که مقدار یک در این پارامتر ارسال شود لیست اتیکت ها با تصویر دریافت می شود.
لیست اتیکت ها: (فقط اتیکت های به روز شده)
{"DoListGetUpdatedEtiket":["AzTarikh","TaTarikh"]}
این دستور لیست اتیکت هایی که در این محدوده ی تاریخ ثبت، ویرایش یا فروخته شده اند را برمی گرداند.
این دستور مناسب برای به روز کردن موجودی کالای سایت یا اپلیکیشن شما می باشد.
لیست اتیکت ها: (فیلتر بر اساس کد کار)
{"DoList_EtiketByCodeKar":["Code_Kar_String"]}
ثبت سند خرید و فروش اتیکت:
{"DoNewSanadBuySaleEtiket":[1_Sabte_Kol_Or_Movaghat_1_0, 2_Moshtari_Code, 3_Factor_Number, 4_Radif_Number, 5_Shamsi_Year, 6_Shamsi_Month, 7_Shamsi_Day, 8_0, 9_0, 10_0, 11_"", 12_BuyOrSale_0_1, 13_Mazaneh, 14_MazanehIsMesghalOrGeram_0_1, 15_MablaghKol, 16_OjratTedadiOrGerami_0_1, 17_Darsad_Maliat, 18_MeghdarMaliat, 19_Darsad_Sood, 20_Darsad_Talayee, 21_IsMarjoo_1_0, 22_PoolSang, 23_"PictureFileName", 24_Ojrat, 25_Shenase]}
ثبت سند ورود و خروج اتیکت:
{"DoNewSanadVKHEtiket":[1_Sabte_Kol_Or_Movaghat_1_0, 2_Moshtari_Code, 3_Factor_Number, 4_Radif_Number, 5_Shamsi_Year, 6_Shamsi_Month, 7_Shamsi_Day, 8_0, 9_0, 10_0, 11_"", 12_BuyOrSale_0_1, 13_0, 14_0, 15_MablaghKol, 16_OjratTedadiOrGerami_0_1, 17_Darsad_Maliat, 18_MeghdarMaliat, 19_0, 20_Darsad_Talayee, 21_IsMarjoo_1_0, 22_PoolSang, 23_"PictureFileName", 24_Ojrat, 25_Shenase]}
سند
لیست اسناد ثبت شده:
{"DoListAsnad":[Count_Last,Moshtari_Code,"AzTarikhShamsi","TaTarikhShamsi"]}
Count_Last
: تعداد اسناد به ترتیب تاریخ از آخر
AzTarikhShamsi
: فیلتر از تاریخ: ۰۱-۰۱-۱۴۰۳
TaTarikhShamsi
: فیلتر تا تاریخ : ۰۱-۰۲-۱۴۰۳
استعلام سند ثبت شده توسط APi:
{"DoNewSanadInquiry":[Moshtari_Code, Factor_Number, Shamsi_Year, Shamsi_Month, Shamsi_Day]}
حذف سند:
{"DoDeleteSanad":["Factor_Code"]}
Factor_Code
: کد منحصر به فرد سند برگشت داده شده در متد های ثبت سند