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


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 کلمۀ عبور تنظیم شدۀ کاربر در زمان فراخوانی متد است.
  • مقادیرObjectType عبارتند از: Invoice، Contact و Product.
  • ObjectIdList آرایه‌ای از ماهیت‌های ذخیره شده، تغییر یافته یا حذف شده است.
  • 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"
	}
}