راهنمای استفاده از وب‌هوک

استفاده از وب هوک در جهت برقراری ارتباط بین دو نرم افزار

وب هوک

وب هوک

وب هوک اساساً یک رویداد اطلاع رسانی است که به URL انتخابی اطلاعات ارسال می‌شود. در واقع وب هوک راهی برای برقراری ارتباط خودکار بین دو نرم‌افزار است.
به محض وقوع رویدادی مسیر URL قرار داده شده فراخوانی می‌شود. وب هوک برای ادغام و یکچارچه‌سازی عملکرد چند نرم‌افزار با یکدیگر مورد استفاده قرار می‌گیرد.
نکته‌ی قابل توجه این است که استفاده از وب هوک نیاز به دانش برنامه نویسی دارد.

وب هوک در فرم افزار

به کارگیری از وب هوک با هدف برقراری ارتباط بین نرم افزارهای مختلف با فرم افزار ایجاد شده است. به این صورت که اگر کاربری فرمی را با استفاده از فرم ساز ثبت کند به نرم افزاری که لینک آن در تنظیمات وب هوک فرم افزار قرار داده شده از طریق وب هوک ارتباط برقرار شده اطلاعات فرم ارسال می‌شود.

نحوه‌ی اتصال به فرم افزار

به منظور تنظیم وب هوک از طریق فرم افزار از زبانه‌ی یکپارچه‌سازی و در منوی وب هوک، سه کادر دریافت آدرس URL قابل پر کردن هستند:

آدرس اینترنتی دریافت رویداد ثبت اطلاعات:به منظور ارسال اطلاعات فرم پس از "ثبت شدن" در این کادر آدرس سرویس نرم افزار مقصد یادداشت می‌شود.
آدرس اینترنتی دریافت رویداد ویرایش اطلاعات: به منظور ارسال اطلاعات فرم پس از "ویرایش" در این کادر آدرس سرویس نرم افزار مقصد یادداشت می‌شود و اطلاعاتی با ساختار زیر به نرم افزار مقصد ارسال می‌شود.
ساختار داده‌های رویداد ثبت و ویرایش فرم یکسان و به شرح زیر است:

{
"form":{ 
"id":"شناسه‌‌ی فرم پر شده",
"formId":"شناسه‌‌ی فرم",
"formattedId":"شناسه‌‌ی اختصاصی",
"creatorId":"شناسه‌‌ی کاربر ثبت کننده‌",
"creatorName":"نام کاربر ثبت کننده‌",
"createDate":"تاریخ ثبت",
"editorId":"شناسه‌‌ی ویرایش کننده",
"editorName":"نام ویرایش کننده",
"editDate":"تاریخ ویرایش",
"custCode":"شناسه‌‌ی مشتری",
"custName":"نام مشتری",
"urlReferrer":"آدرس اینترنتی ثبت فرم",
"browser":"نام مرورگر",
"ip":"آی پی",
"coordinate":"موقعیت جغرافیایی",
"params":[ //آرایه‌ای از پارامترهای فیلدهای فرم
{
"fieldId":"شناسه‌‌ی فیلد",
"title":"مقدار متنی",
"value":"مقدار",
"number":"مقدار عددی",
"group":"گروه پارامتر"
}
]
}
}

آدرس اینترنتی دریافت رویداد حذف اطلاعات: زمانی که فرمی حذف شود آدرس سرویس نرم افزار مقصد که در این کادر نوشته می‌شود فراخوانی شده و اطلاعاتی با ساختار داده زیر ارسال خواهد شد.

{
"ids":[ //آرایه‌ای از شناسه‌های اطلاعات ثبت شده
"شناسه فرم حذف شده"
]
}

و با انجام شدن هرکدام از رویدادهای فوق، یک فراخوان اطلاع رسانی با متد POST به آدرس اینترنتی وارد شده ارسال می‌شود.
با قابلیت وب هوک فرمساز فرم افزار به راحتی می‌توان با نرم افزارهای دیگر ارتباط برقرار نمود.