topic

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

کسانی که با صنعت IT آشنایی دارند حتما تا کنون نام وب سرویس را بارها شنیده اند. API مخفف واژگان Application Programming Interface است که به صورت تحت‌الفظی می‌توان آن را به "رابط برنامه‌نویسی نرم‌افزار" ترجمه کرد. به طور خلاصه،API  همچون همان UI است با این تفاوت که به جای انسان، یک سیستم کامپیوتری قرار است با آن تعامل داشته باشد.

در برنامه نویسی رایانه ای، یک رابط برنامه نویسی برنامه (API) مجموعه ای از تعاریف فرعی ، پروتکل های ارتباطی و ابزارهایی برای ساختن نرم افزار است. به طور کلی ، برای سهولت و تسریع در فرآیند توسعه نرم افزار و همچنین ارتباط بین نرم افزارهایی که یکپارچه نیستند، نیاز است تبادلاتی بین این نرم افزارها انجام شود که این ارتباطات از طریق وب سرویس انجام می شود.

به عنوان مثال، بانک ها وب سرویس پرداخت آنلاین وجه را ارائه می کنند و یا شرکت های ارسال پیامک، وب سرویس ارسال پیامک را از داخل سایر نرم افزارها ارائه می دهند.

حال شما می توانید با استفاده از وب سرویس یا  رابط برنامه نویسی برنامه نرم افزار حسابداری ابرآ، سایر نرم افزارها یا سایت خود را به آن متصل نمایید.

برای مطالعه بیشتر می توانید مقاله "API چیست؟" را مطالعه نمایید.

تنظیمات اولیه

وب سرویس ابرآ با استفاده از تکنولوژی webApi پیاده سازی شده و انتقال اطلاعات بر اساس پروتکل HTTP و HTTPS می باشد مقادیر ارسالی و دریافتی بر اساس JSON می باشد و کلیه متد ها، مقادیر ارسالی را بر اساس ساختار مشخصی از  JSON ها که در ادامه تشریح خواهد شد به کلاینت انتقال می دهند.

آدرس وب سرویس:

حسابداری آنلاین: در صورتی که شما از نسخه های ابری استفاده می کنید و بسته خریداری شده شما دارای قابلیت API می باشد، می توانید با استفاده از آدرس زیر به این سرویس متصل شوید:

https://test.gheyas.com/doc/index.html

لیسانس تحت وب: در صورتی که نرم افزار حسابداری قیاس را بصورت لیسانس تهیه نموده اید و بر روی سرور شما نصب شده است، می توانید با درج /DOC به انتهای آدرس صفحه اصلی نرم افزار، لیست API ها را مشاهده نمایید  به عنوان مثال:

https://10.10.10.10:8080/doc/index.html

نمونه وب سرویس های قیاس

لیست سرویس ها بر اساس زیرسیستم ها تقسیم بندی شده اند – دسته ی مربوط به GeneralAPI شامل سرویس های عمومی نرم افزار می باشد :

نمونه وب سرویس های قیاس

 

شروع بکار:

برای استفاده از وب سرویس، از دو طریق می توان ارتباط گرفت:

1- با استفاده از نام کاربری و پسورد

  • در واقع شما با هر نام کاربری که امکان ورود به حسابداری آنلاین ابرآ را داشته باشید، می توانید با استفاده از متد لاگین نسبت به دریافت session id اقدام نمایید:

متد لاگین:  

/GeneralApi/LoginUser

2- با استفاده از کلید

  • وارد نرم افزار حسابداری آنلاین ابرآ شده، از قسمت عمومی، تعریف کاربر، با قرارگرفتن بر روی کاربر مورد نظر جهت اتصال به وب سرویس، با زدن دکمه ایجاد کلید، کلید را ایجاد و برای ارتباطات بعدی استفاده نمایید:

متد لاگین:

   /GeneralApi/LoginUserByToken

 

 

آدرس نمونه : 

https://test.gheyas.com/GeneralApi/LoginUser

 

{

"UserName": "string",    --------------> نام کاربری

"Password": "string"     ---------------> پسورد

}

مقادیر بازگشتی:

مقادیر بازگشتی از سرور با فراخوانی متد های API، در قالب JSON بازگشت داده می شود و توجه نمایید که SessionId که پس از اجرای متد لاگین بدست می آید را در سایر متدها استفاده نمایید: 

{

"SessionId": "52A8F.......930",    --------------> توکن لاگین جهت استفاده از سرویس های دیگر

"BaseCurrencyCode": 0,

"BaseCurrencyName": "string",

"BaseCurrencyDecimalCount": 0,

"CurrentYear": 0,

"CurrentYearName": "string",

"CurrentYearFromDate": "string",

"CurrentYearToDate": "string",

"StartSalMali": "2022-12-19T14:25:00.639Z",

and .... 

}

وب هوک : در حال اضافه شدن است