راهنمای ایجاد وب‌هوک

سرویس وب‌هوک به شما امکان می‌دهد هنگام وقوع یک رخداد مشخص (Event)، اطلاعات مرتبط با آن رخداد را به صورت خودکار در سرویس خود دریافت کنید. در ادامه سناریوهای متفاوت وب‌هوک شرح داده شده است:

سناریو اول: ایجاد وب‌هوک برای سرویس شخصی

اگر قصد دارید برای اکانت یا غرفه‌ خود در باسلام رخدادهایی را پایش کرده و در سرویس شخصی خود دریافت کنید، مراحل زیر را دنبال کنید:

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

{
  "Authorization": "Bearer [YOUR_SERVICE_TOKEN]"
}

در انتها هر زمان رخدادی اتفاق بیفتد، به آدرس وب‌‌هوک شما ارسال می‌شود.

سناریو دوم: ایجاد وب‌هوک به‌عنوان پلتفرم یا سرویس‌دهنده

اگر شما یک پلتفرم یا ارائه‌دهنده خدمات به غرفه‌داران یا کاربران باسلام هستید، می‌توانید وب‌هوک‌های خود را به‌صورت برنامه‌نویسی‌شده از طریق API تنظیم کنید.

• ابتدا سرویس خود را از طریق API ساخت سرویس ایجاد کنید.
• برای ایجاد وب‌هوک نیاز به انتخاب رخداد موردنظر می‌باشد که از API لیست رخدادها قابل دریافت است. برای هر رخداد نمونه اطلاعاتی که سمت شما ارسال می‌شود در پروپرتی sample_data قرار داده شده است.
• سپس می‌توانید از API ساخت وب‌هوک، وب‌هوک خود را ایجاد کنید.

curl -X POST https://webhook.basalam.com/v1/webhooks \
 -H 'Accept: application/json' \
 -H 'Content-Type: application/json' \
 -H 'Authorization: Bearer [TOKEN]' \
 -d '{
 "event_ids": [
   8, 4
 ],
 "request_method": "POST",
 "url": "http://example.com",
 "is_active": true,
 "register_me": true
}

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

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

رخدادهای فعلی وب‌هوک شامل موارد زیر هستند (هر رخداد شامل نام، آی‌دی و دسترسی مورد نیاز است):