وب هوک
URL: https://api.hesabfa.com/v1/setting/SetChangeHook
با فراخوانی این متد، حسابفا تغییرات انجام شده روی فاکتور، کالا و خدمات و اشخاص را به URL تنظیم شده ارسال می کند.
ورودی
پارامترهای اجباری:
apiKey userId password loginToken |
پارامتر های اجباری برای تمامی متد ها
(مشاهده توضیحات) |
url | url مورد نظر جهت ارسال تغییرات |
hookPassword | کلمه عبور مورد نظر |
مثال:
{ apiKey: 'asdfASR^%FDHdsfg456', userId: '[email protected]', password: '123456', loginToken: 'f6b912...45fdc', url: 'http://example.url.com', hookPassword: 'custom-user-password' }
خروجی
ندارد
پس از تنظیم این متد، کلیه تغییرات انجام گرفته روی فاکتور، کالا و خدمات و اشخاص، به صورت لحظه ای به URL تنظیم شده ارسال می شود.
توجه
- URL باید وب سرویس REST و متد بکارگرفته شده باید POST باشد.
- اطلاعات در قالب JSON با فرمت زیر ارسال می شود.
{ Password: "custom-user-password ", Action: action, ObjectType: “Product”, ObjectIdList: [1,2,3] }
- Password کلمه عبور تنظیم شده توسط کاربر در هنگام فراخوانی متد SetChangeHook است.
- مقادیر ObjectType عبارتند از: Product, Contact, Invoice
- ObjectIdList آرایه ای از Id ماهیت هایی که ذخیره شده، تغییر کرده یا حذف شده اند است.
- Action مطابق جدول زیر:
شرح | کد |
---|---|
ذخیره شخص | 31 |
ویرایش شخص | 32 |
حذف شخص | 33 |
ذخیره کالا | 51 |
ویرایش کالا | 52 |
حذف کالا | 53 |
ذخیره فاکتور فروش | 121 |
ویرایش فاکتور فروش | 122 |
حذف فاکتور فروش | 123 |
ذخیره فاکتور خرید | 131 |
ویرایش فاکتور خرید | 132 |
حذف فاکتور خرید | 133 |
ذخیره فاکتور برگشت از فروش | 141 |
ویرایش فاکتور برگشت از فروش | 142 |
حذف فاکتور برگشت از فروش | 143 |
ذخیره فاکتور برگشت از خرید | 151 |
ویرایش فاکتور برگشت از خرید | 152 |
حذف فاکتور برگشت از خرید | 153 |
ذخیره فاکتور ضایعات | 161 |
ویرایش فاکتور ضایعات | 162 |
حذف فاکتور ضایعات | 163 |