معرفی API حسابداری
در این مقاله قصد داریم در مورد معرفی وب سرویس حسابداری صحبت کنیم.
نحوه پیکربندی
واسط برنامه نویسی حساب فا (API) با استفاده از تکنولوژی Web Api2 پیاده سازی شده است و انتقال اطلاعات بر اساس پروتکل HTTP می باشد. این سرویس عملیات ها را در قالب متد هایی ارائه می دهد که سمت سرور پیاده سازی شده اند و برنامه نویس می تواند این متد ها را به صورت مستقیم فراخوانی کند. مقادیر ارسالی و دریافتی بر اساس JSON بوده و کلیه متد ها، مقادیر ارسالی را بر اساس ساختار مشخصی از شی های JSON که در ادامه تشریح خواهد شد به کلاینت انتقال می دهند.
پیش نیاز ها
apiKey: مجوز استفاده از سرویس API حساب فا از طریق apiKey تایید می شود که این apiKey به ازاء هر کسب و کار یکتا بوده و معرف آن کسب و کار می باشد. برای به دست آوردن apiKey می توانید در پنل کاربری کسب و کار مورد نظر از منوی تنظیمات > واسط برنامه نویسی به apiKey دسترسی پیدا کنید.
userId: نام کاربری صاحب کسب و کار که در حساب فا به منظور ورود به سیستم استفاده می شود.
password: کلمه عبور صاحب کسب و کار که در حساب فا به منظور ورود به سیستم استفاده می شود.
نکات ضروری
- کلیه درخواست های ارسالی به سرور باید به روش POST باشند.
- در بدنه کلیه درخواست ها باید یک آبجکت JSON به نام data وجود داشته باشد که مقادیر ارسالی به عنوان پارامتر در آن ذخیره شده باشند.
- سه پارامتر apiKey,userId,password باید به همراه کلیه درخواست ها به سرور ارسال شوند. یعنی به عنوان فیلدهای اطلاعاتی شی data ذکر شده در بند 2 قرار داشته باشند.
- کلیه تاریخ ها در سیستم API حسابفا به صورت میلادی تعریف شده اند. قالب تاریخ به شکل YYYY-MM-DD HH:MM:SS است.
نکته مهم
- سیستم API حسابفا در هر دقیقه از هر IP حداکثر به 50 درخواست پاسخ خواهد داد.
در این مقاله در مورد معرفی وب سرویس حسابداری صحبت کردیم در مقاله های بعدی در مورد مثال این وب سرویس و جداول کدهای خطا این وب سرویس توضیح میدهیم.