سامانه‌ای که با رمزارز کار می‌کند باید بداند واریز کاربر چه زمانی رسیده است. یک راه این است که سامانه هر چند ثانیه وضعیت را بپرسد. راه بهتر این است که سرویس زیرساخت، خودش رویداد را در همان لحظه اعلام کند. وب‌هوک1 همین کار را انجام می‌دهد.
زربان سازمانی رویداد واریز، برداشت و تغییر وضعیت حساب را بلادرنگ به نشانی شما می‌فرستد. این راهنما مراحل راه‌اندازی و نکته‌های فنی آن را مرور می‌کند.
خلاصه مطلب: نشانی خود را در داشبورد ثبت می‌کنید و رویدادهای دلخواه را برمی‌گزینید. زربان هر رویداد را امضا می‌کند و به نشانی شما می‌فرستد. داشبورد هم گزارش تحویل هر رویداد را با وضعیت، کد پاسخ و مدت زمان نگه می‌دارد.
زربان چه رویدادهایی را می‌فرستد؟
| گروه | رویداد | زمان ارسال |
|---|---|---|
| تراکنش | WebhookTransactionCoinDeposit | واریز رمزارز به حساب می‌رسد. |
| تراکنش | WebhookTransactionCoinWithdrawal | وضعیت برداشت رمزارز تغییر می‌کند. |
| تراکنش | WebhookTransactionInternalTransfer | انتقال داخلی میان دو حساب انجام می‌شود. |
| حساب | WebhookAccountCreated | حساب تازه‌ای ساخته می‌شود. |
| حساب | WebhookAccountUpdated | وضعیت یا مشخصات حساب تغییر می‌کند. |
| وام | WebhookDebtPositionActivated | وثیقه قفل و موقعیت بدهی فعال می‌شود. |
| وام | WebhookDebtPositionLiquidated | زربان وثیقه را نقد می‌کند. |
فهرست کامل رویدادها در مستندات یکپارچه‌سازی سازمانی آمده است.
راه‌اندازی در سه مرحله
- در بخش وب‌هوک‌های داشبورد، نشانی سرور خودتان را ثبت کنید.
- رویدادهایی را که لازم دارید انتخاب کنید.
- کلید امضا را از داشبورد بردارید و در سرور خودتان ذخیره کنید.
از این لحظه، زربان هر رویداد را با یک درخواست به نشانی شما اعلام می‌کند:
POST https://your-app.ir/webhooks
{ "name": "WebhookTransactionCoinDeposit" }
امضای هر رویداد را بررسی کنید
زربان هر درخواست را با کلید امضای همان وب‌هوک امضا می‌کند. سرور شما امضا را به روش اچ‌مک2 روی بدنه خام درخواست محاسبه می‌کند و آن را با سرآیند امضای دریافتی می‌سنجد. اگر دو مقدار برابر باشند، رویداد اصیل است.
کلید امضا را هر زمان که بخواهید در داشبورد عوض می‌کنید. پس از تغییر کلید، مقدار تازه را در سرور خودتان هم به‌روز کنید.
تحویل هر رویداد را پیگیری کنید
داشبورد برای هر وب‌هوک فهرست تحویل‌ها را نگه می‌دارد. در این فهرست زمان، نام رویداد، وضعیت، کد پاسخ سرور شما، شماره تلاش و مدت زمان هر تحویل دیده می‌شود. بدنه درخواست و بدنه پاسخ هم در جزئیات هر تحویل ثبت شده است.
تیم پشتیبانی با همین گزارش مسیر یک واریز را از لحظه رسیدن تا پاسخ سرور شما دنبال می‌کند. اگر تحویلی ناموفق باشد، آن را از همان صفحه دوباره می‌فرستید.
وب‌هوک‌های زربان سازمانی را در عمل ببینید
شماره‌تان را بگذارید تا در ساعات کاری تماس بگیریم و مسیر یک رویداد را از زنجیره تا سامانه شما نشان دهیم.
چند توصیه برای پیاده‌سازی
- رویداد را دریافت و ذخیره کنید، بی‌درنگ پاسخ موفق بدهید و پردازش را پس از آن انجام دهید.
- پردازش را طوری بنویسید که دریافت دوباره یک رویداد، موجودی کاربر را دو بار تغییر ندهد.
- برای محیط آزمایشی و محیط عملیاتی وب‌هوک جداگانه ثبت کنید.
- هر وب‌هوک را در زمان نگهداری سرور موقتاً متوقف کنید و سپس دوباره فعال کنید.
سؤالات متداول
چند وب‌هوک می‌توانیم ثبت کنیم؟
برای هر نشانی یک وب‌هوک ثبت می‌کنید و برای هر کدام رویدادهای جداگانه برمی‌گزینید.
از کجا بفهمیم رویدادی به سرور ما رسیده است؟
فهرست تحویل‌ها در داشبورد وضعیت و کد پاسخ هر رویداد را نشان می‌دهد.
وب‌هوک در کدام گام یکپارچه‌سازی قرار دارد؟
وب‌هوک گام سوم است. دو گام پیش از آن را در راهنمای از صفر تا اولین واریز در سه گام بخوانید.