اگر می‌خواهید داده‌های ثبت‌شده در پرس‌لاین را به سیستم CRM، باشگاه مشتریان، سرورهای داخلی سازمان یا ابزارهایی مانند Power BI منتقل کنید، می‌توانید از API و وب‌هوک استفاده کنید. این روش‌ها به شما امکان می‌دهند داده‌های پرسشنامه را در سیستم‌های دیگر دریافت کنید و متناسب با نیاز کسب‌وکار خود، در فرایندهای مختلف از آن‌ها استفاده کنید.
در این مقاله، تفاوت API و وب‌هوک پرس‌لاین را توضیح می‌دهیم و روش انتقال داده‌های پرسشنامه به نرم‌افزارها و سرورهای دیگر را بررسی می‌کنیم.
تفاوت API و وب‌هوک پرس‌لاین چیست؟
API و وب‌هوک دو روش برای انتقال داده بین پرس‌لاین و سایر سیستم‌ها هستند، اما تفاوت اصلی آن‌ها در نحوه دریافت داده‌هاست.
- API: نرم‌افزار یا سرور شما در زمان موردنیاز، درخواستی به API پرس‌لاین ارسال می‌کند و داده‌های موردنظر را دریافت می‌کند. برای مثال، می‌توانید پاسخ‌های یک پرسشنامه را در بازه زمانی مشخص دریافت کنید.
- وب‌هوک (Webhook): با وقوع یک رویداد مشخص، مانند ثبت پاسخ جدید در پرس‌لاین، اطلاعات به‌صورت خودکار به نشانی تعیین‌شده ارسال می‌شوند.
به‌طور خلاصه، اگر می‌خواهید خودتان زمان دریافت داده‌ها را تعیین کنید، API گزینه مناسبی است. اگر می‌خواهید داده‌ها پس از وقوع یک رویداد به‌صورت خودکار ارسال شوند، می‌توانید از وب‌هوک استفاده کنید.
اندپوینت (Endpoint) چیست؟
اندپوینت، نشانی مشخصی است که یک نرم‌افزار از طریق آن با نرم‌افزار یا سرویس دیگری ارتباط برقرار می‌کند. در انتقال داده با وب‌هوک، این نشانی مشخص می‌کند اطلاعات باید به کجا ارسال شوند.
برای مثال، اگر سرور شما برای دریافت اطلاعات یک نشانی مشخص داشته باشد، می‌توانید آن را به‌عنوان اندپوینت وب‌هوک در پرس‌لاین وارد کنید:
https://example.com/receive-data
این نشانی صرفاً یک مثال است و باید با نشانی واقعی سرویس مقصد جایگزین شود.
روش اول: انتقال خودکار داده‌ها با وب‌هوک پرس‌لاین
با استفاده از وب‌هوک، می‌توانید تعیین کنید که در چه شرایطی و با چه ساختاری، داده‌های پرسشنامه به یک نشانی مشخص ارسال شوند.
مرحله اول: تعیین شرط ارسال وب‌هوک
پس از انتخاب گزینه «افزودن وب‌هوک»، در قسمت «در چه صورتی وب‌هوک ارسال شود» شرط مورد نظر خود را انتخاب کنید.
برای مثال، با انتخاب گزینه «تمام پاسخ‌ها»، وب‌هوک برای پاسخ‌هایی که مطابق شرط انتخاب‌شده هستند ارسال می‌شود. بسته به نیاز خود می‌توانید شرایط دیگری را نیز تعیین کنید.
مرحله دوم: وارد کردن نشانی مقصد
در قسمت URL یا نشانی اندپوینت، آدرس سرویس یا سروری را وارد کنید که قرار است داده‌ها را دریافت کند.
برای مثال:
https://example.com/receive-data
در صورت نیاز، می‌توانید با استفاده از متغیرهای پرس‌لاین، بخشی از نشانی را نیز به پاسخ‌دهنده یا پاسخ ثبت‌شده مرتبط کنید. برای نمونه، می‌توانید شماره تماس پاسخ‌دهنده را به‌عنوان یک پارامتر به نشانی اضافه کنید.
مرحله سوم: انتخاب متد ارسال
متد مشخص می‌کند درخواست وب‌هوک با چه روشی به مقصد ارسال شود. متدهای قابل‌استفاده به تنظیمات سرویس مقصد بستگی دارند.
معمولاً از متد POST برای ارسال داده استفاده می‌شود؛ زیرا امکان قرار دادن اطلاعات در بدنه درخواست را فراهم می‌کند. پیش از انتخاب متد، مستندات سرویس مقصد را بررسی کنید.
مرحله چهارم: تنظیم هدرها (Headers)
هدرها اطلاعات تکمیلی مورد نیاز برای پردازش درخواست را در اختیار سرویس مقصد قرار می‌دهند.
برای مثال، اگر داده‌ها را با فرمت JSON ارسال می‌کنید، ممکن است لازم باشد هدر زیر را تنظیم کنید:
Content-Type: application/json
اگر سرویس مقصد به احراز هویت نیاز داشته باشد، باید هدرهای مربوط به آن را نیز مطابق مستندات سرویس تنظیم کنید.
مرحله پنجم: تعیین ساختار داده‌های ارسالی (Payload)
در این مرحله، مشخص می‌کنید چه اطلاعاتی از پاسخ پرسشنامه به مقصد ارسال شوند. برای نمونه، اگر فقط نام و شماره تماس پاسخ‌دهنده موردنیاز باشد، می‌توانید ساختار داده را به شکل زیر تعریف کنید:
{
"name": "@نام",
"phone": "@شماره تماس"
}
در این مثال، متغیرهای @نام و @شماره تماس با پاسخ‌های ثبت‌شده در پرس‌لاین جایگزین می‌شوند. برای افزودن متغیرها، می‌توانید از علامت @ استفاده کنید. اگر قصد دارید تمام پاسخ‌های پرسشنامه را ارسال کنید، گزینه «پاسخ تمامی سوال‌ها» را انتخاب کنید. ساختار داده‌ها باید با فرمتی که سرویس مقصد انتظار دارد مطابقت داشته باشد.
مرحله ششم: ذخیره و آزمایش وب‌هوک
پس از تکمیل تنظیمات، وب‌هوک را ذخیره کنید. سپس از منوی سه‌نقطه، گزینه ارسال درخواست تستی را انتخاب کنید تا از صحت تنظیمات مطمئن شوید.
برای بررسی نتیجه، به بخش «لاگ ارسال‌ها» مراجعه کنید. در این قسمت می‌توانید وضعیت درخواست و کد پاسخ HTTP را بررسی کنید. برای مثال، کد 200 معمولاً نشان می‌دهد که سرور مقصد درخواست را با موفقیت پاسخ داده است؛ البته این موضوع به‌تنهایی تضمین نمی‌کند که داده‌ها در سیستم مقصد ذخیره یا پردازش شده‌اند.
روش دوم: دریافت داده‌های پرس‌لاین با API
با API پرس‌لاین می‌توانید از طریق ارسال درخواست، پاسخ‌های ثبت‌شده در پرسشنامه را دریافت کنید و از این داده‌ها در نرم‌افزار یا سرور خود استفاده کنید. برای مثال، می‌توانید اطلاعات پاسخ‌دهندگان را به سیستم CRM منتقل کنید یا داده‌های پرسشنامه را در سیستم‌های داخلی سازمان به کار بگیرید.
مرحله اول: مشاهده مستندات API پرس‌لاین
برای آشنایی با مسیرهای ارتباطی، پارامترها و نحوه ارسال درخواست‌ها، مستندات API پرس‌لاین را مشاهده کنید.
در این مستندات، مسیر دریافت پاسخ‌های پرسشنامه و امکان محدود کردن نتایج بر اساس بازه زمانی و تعداد پاسخ‌ها توضیح داده شده است.
مرحله دوم: دریافت کلید API و شناسه پرسشنامه
برای ارسال درخواست به API، به دو مورد نیاز دارید:
- کلید API: برای احراز هویت درخواست‌ها استفاده می‌شود. برای دریافت آن، به بخش پروفایل خود در پرس‌لاین و قسمت API Key مراجعه کنید و کلید موردنیاز را بسازید.
- شناسه پرسشنامه (Survey ID): شناسه عددی پرسشنامه است که می‌توانید آن را در نشانی صفحه ساخت پرسشنامه، پس از عبارت /survey، پیدا کنید.
کلید API را محرمانه نگه دارید و آن را در اختیار افراد غیرمجاز قرار ندهید.
مرحله سوم: ارسال درخواست به API پرس‌لاین
پس از دریافت کلید API و شناسه پرسشنامه، می‌توانید با با زبان‌های برنامه‌نویسی یا ابزارهای گوناگون دیگر به API پرس‌لاین درخواست بفرستید و پاسخ‌های پرسشنامه را دریافت کنید.
برای مثال، اگر بخواهید اطلاعات پاسخ‌دهندگان را در نرم‌افزار CRM ثبت کنید، ابتدا باید پاسخ‌ها را از API پرس‌لاین دریافت کنید و سپس با استفاده از API نرم‌افزار CRM، اطلاعات مورد نیاز را به آن منتقل کنید.
کد زیر نمونه‌ای از دریافت پاسخ‌های پرسشنامه با استفاده از کتابخانه requests در پایتون است. این کد داده‌های دریافتی را نمایش می‌دهد و انتقال آن‌ها به CRM به پیاده‌سازی مرحله جداگانه‌ای نیاز دارد.
این کد صرفا داده‌ها را از پرس‌لاین دریافت می‌کند. برای انتقال آن‌ها به یک نرم‌افزار یا سرور دیگر، باید متناسب با امکانات و مستندات سرویس مقصد، مرحله ارسال داده‌ها را نیز پیاده‌سازی کنید.
API و وب‌هوک دو روش برای انتقال داده‌های پرس‌لاین به سایر سیستم‌ها هستند. با API، زمان و نحوه دریافت داده‌ها را کنترل می‌کنید؛ با وب‌هوک، داده‌ها پس از وقوع رویدادهای مشخص به‌صورت خودکار ارسال می‌شوند.
انتخاب روش مناسب به نیاز شما و امکانات سرویس مقصد بستگی دارد. برای اتصال به سیستم CRM، باشگاه مشتریان، سرورهای داخلی سازمان یا ابزارهایی مانند Power BI، لازم است روش دریافت داده‌ها در سیستم مقصد نیز بررسی شود. در نهایت، با تنظیم درست درخواست‌ها و ساختار داده‌ها می‌توانید از پاسخ‌های پرسشنامه در سایر فرایندهای مورد نیاز خود استفاده کنید.