2023-01-01 00:00:00 persion راهنمای حسابفا پیکربندی واسط API https://www.hesabfa.com/help/api/Configuration/ پیکربندی واسط-حسابفا API

پیکربندی واسط API

نحوه پیکربندی
واسط برنامه نویسی حسابفا (API) با استفاده از تکنولوژی Web Api2 پیاده سازی شده است و انتقال اطلاعات بر اساس پروتکل HTTP می باشد. این سرویس عملیات ها را در قالب متد هایی ارائه می دهد که سمت سرور پیاده سازی شده اند و برنامه نویس می تواند این متد ها را به صورت مستقیم فراخوانی کند. مقادیر ارسالی و دریافتی بر اساس JSON بوده و کلیه متد ها، مقادیر ارسالی را بر اساس ساختار مشخصی از شی های JSON که در ادامه تشریح خواهد شد به کلاینت انتقال می دهند.
پیش نیاز ها
apiKey: مجوز استفاده از سرویس API حسابفا از طریق apiKey تایید می شود که این apiKey به ازاء هر کسب و کار یکتا بوده و معرف آن کسب و کار می باشد.
برای دریافت این توکن در حسابفا به قسمت تنظیمات/تنظیمات مالی/API بروید.
loginToken: توکن ورود به کسب و کار
برای دریافت این توکن در حسابفا به قسمت تنظیمات/تنظیمات مالی/API بروید.
userId: نام کاربری صاحب کسب و کار که در حسابفا به منظور ورود به سیستم استفاده می شود.
password: کلمه عبور صاحب کسب و کار که در حسابفا به منظور ورود به سیستم استفاده می شود.

نکات ضروری
  1. احراز هویت به دو روش انجام می شود:
    از طریق loginToken
    از طریق userId و password صاحب کسب و کار
    در صورتی که در پارامترها مقدار loginToken ذکر شده باشد نیازی به userId و password نیست، اما اگر پارامتر loginToken وجود نداشته باشد احراز هویت از طریق userId و password انجام می گیرد.
  2. کلیه درخواست های ارسالی به سرور باید به روش POST باشند.
  3. در بدنه کلیه درخواست ها باید یک آبجکت JSON به نام data وجود داشته باشد که مقادیر ارسالی به عنوان پارامتر در آن ذخیره شده باشند.
  4. کلیه تاریخ ها در سیستم API حسابفا به صورت میلادی تعریف شده اند. قالب تاریخ به شکل YYYY-MM-DD HH:MM:SS است.
نکته مهم

سیستم API حسابفا در هر دقیقه از هر IP حداکثر به 50 درخواست پاسخ خواهد داد.