وب هوک تغییرات در رابط برنامه نویسی حسابفا


Copyed
URL: https://api.hesabfa.com/v1/setting/SetChangeHook

پارامترهای اجباری:

apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
url url مورد نظر جهت ارسال تغییرات
hookPassword کلمه عبور مورد نظر
Copyed
{
	 apiKey: 'asdfASR^%FDHdsfg456',
	 userId: 'mail@example.com',
	 password: '123456',
	 loginToken: 'f6b912...45fdc',
	 url: 'http://example.url.com',
	 hookPassword: 'custom-user-password'
 }  
  • پس از تنظیم این متد، کلیه تغییرات انجام گرفته روی فاکتور، کالا و خدمات و اشخاص، به صورت لحظه ای به URL تنظیم شده ارسال می شود.
  • URL باید وب سرویس REST و متد بکارگرفته شده باید POST باشد.
  • اطلاعات در قالب JSON با فرمت زیر ارسال می شود.
Copyed
{
	Password: "custom-user-password ",
	Action: action,
	ObjectType: “Product”,
	ObjectIdList: [1,2,3]
}
نکات ضروری
  • Password کلمه عبور تنظیم شده توسط کاربر در هنگام فراخوانی متد SetChangeHook است.
  • مقادیر ObjectType عبارتند از: Product, Contact, Invoice
  • ObjectIdList آرایه ای از Id ماهیت هایی که ذخیره شده، تغییر کرده یا حذف شده اند است.
  • Action نوع عملیات(جدول نوع عملیات)

آیتم های موجود در پاسخ:

Result ندارد
Copyed
URL: https://api.hesabfa.com/v1/setting/GetChangeHook

پارامترهای اجباری:

apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Copyed
{
	 apiKey: 'asdfASR^%FDHdsfg456',
	 loginToken: 'f6b912...45fdc',
 }  

آیتم های موجود در پاسخ:

apiKey
userId
password
loginToken
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات)
Result
url url تعیین شده جهت ارسال تغییرات
password کلمه عبور تعیین شده
Copyed
{
	"Success": true,
	"ErrorCode": 0,
	"ErrorMessage": "",
	"Result": {
		"url": "http://example.url.com",
		"password": "custom-user-password"
	}
}