phpgithubwebhook技巧_本地开拓若何测试 Webhook

文章目录 [+]

Webhook 可用于外部系统关照你的系统发生了某个事宜或更新。

-- Stefan Doorn（作者）

phpgithubwebhook技巧_本地开拓若何测试 Webhook

Webhook 可用于外部系统关照你的系统发生了某个事宜或更新。
可能最有名的 Webhook 类型是支付做事供应商（PSP）关照你的系统支付状态有了更新。

（图片来自网络侵删）

它们常日以监听的预定义 URL 的形式涌现，例如 http://example.com/webhooks/payment-update。
同时，另一个别系向该 URL 发送具有特定有效载荷的 POST 要求（例如支付 ID）。
一旦要求进入，你就会得到支付 ID，可以通过 PSP 的 API 用这个支付 ID 向它们讯问最新状态，然后更新你的数据库。

其他例子可以在这个对 Webhook 的出色的阐明中找到： https://sendgrid.com/blog/whats-webhook/ 。

只要系统可通过互联网公开访问（这可能是你的生产环境或可公开访问的临时环境），测试这些 webhook 就相称顺利。
而当你在条记本电脑上或虚拟机内部（例如，Vagrant 虚拟机）进行本地开拓时，它就变得困难了。
在这些情形下，发送 webhook 的一方无法公开访问你确当地 URL。
此外，监视发送的要求也很困难，这可能使开拓和调试变得困难。

因此，这个例子将办理：

测试来自本地开拓环境的 webhook，该环境无法通过互联网访问。
从做事器向 webhook 发送数据的做事无法访问它。
监控发送的要乞降数据，以及运用程序天生的相应。
这样可以更轻松地进行调试，从而缩短开拓周期。

前置需求：

可选：如果你利用虚拟机（VM）进行开拓，请确保它正在运行，并确保在 VM 中完成后续步骤。
对付本教程，我们假设你定义了一个 vhost：webhook.example.vagrant。
我在本教程中利用了 Vagrant VM，但你可以自由选择 vhost。
按照这个安装解释安装 ngrok。
在 VM 中，我创造它的 Node 版本也很有用： https://www.npmjs.com/package/ngrok ，但你可以随意利用其他方法。

我假设你没有在你的环境中运行 SSL，但如果你利用了，请将不才面的示例中的端口 80 更换为端口 433，http:// 更换为 https://。

使 webhook 可测试

我们假设以下示例代码。
我将利用 PHP，但请将其视作伪代码，由于我留下了一些关键部分（例如 API 密钥、输入验证等）没有编写。

第一个文件：payment.php。
此文件创建一个 $payment 工具，将其注册到 PSP。
然后它获取客户须要访问的 URL，以便支付并将用户重定向到客户那里。

请把稳，此示例中的 webhook.example.vagrant 是我们为开拓设置定义确当地虚拟主机。
它无法从外部天下进入。

<?php/ This file creates a payment and tells the PSP what webhook URL to use for updates After creating the payment, we get a URL to send the customer to in order to pay at the PSP /$payment = [ 'order_id' => 123, 'amount' => 25.00, 'description' => 'Test payment', 'redirect_url' => 'http://webhook.example.vagrant/redirect.php', 'webhook_url' => 'http://webhook.example.vagrant/webhook.php',];$payment = $paymentProvider->createPayment($payment);header(\公众Location: \"大众 . $payment->getPaymentUrl());

第二个文件：webhook.php。
此文件等待 PSP 调用以得到有关更新的关照。

<?php/ This file gets called by the PSP and in the $_POST they submit an 'id' We can use this ID to get the latest status from the PSP and update our internal systems afterward / $paymentId = $_POST['id'];$paymentInfo = $paymentProvider->getPayment($paymentId);$status = $paymentInfo->getStatus();// Perform actions in here to update your systemif ($status === 'paid') { ..}elseif ($status === 'cancelled') { ..}

我们的 webhook URL 无法通过互联网访问（请记住它：webhook.example.vagrant）。
因此，PSP 永久不可能调用文件 webhook.php，你的系统将永久不会知道付款状态，这终极导致订单永久不会被运送给客户。

幸运的是，ngrok 可以办理这个问题。
ngrok 将自己描述为：

ngrok 通过安全隧道将 NAT 和防火墙后面确当地做事器暴露给公共互联网。

让我们为我们的项目启动一个基本的隧道。
在你的环境中（在你的系统上或在 VM 上）运行以下命令：

ngrok http -host-header=rewrite webhook.example.vagrant:80

阅读其文档可以理解更多配置选项： https://ngrok.com/docs 。

会涌现这样的屏幕：

ngrok 输出

我们刚刚做了什么？基本上，我们指示 ngrok 在端口 80 建立了一个到 http://webhook.example.vagrant 的隧道。
同一个 URL 也可以通过 http://39741ffc.ngrok.io 或 https://39741ffc.ngrok.io 访问，它们能被任何知道此 URL 的人通过互联网公开访问。

请把稳，你可以同时得到 HTTP 和 HTTPS 两个做事。
这个文档供应了如何将此限定为 HTTPS 的示例： https://ngrok.com/docs#bind-tls 。

那么，我们如何让我们的 webhook 现在事情起来？将 payment.php 更新为以下代码：

<?php/ This file creates a payment and tells the PSP what webhook URL to use for updates After creating the payment, we get a URL to send the customer to in order to pay at the PSP /$payment = [ 'order_id' => 123, 'amount' => 25.00, 'description' => 'Test payment', 'redirect_url' => 'http://webhook.example.vagrant/redirect.php', 'webhook_url' => 'https://39741ffc.ngrok.io/webhook.php',];$payment = $paymentProvider->createPayment($payment);header(\"大众Location: \"大众 . $payment->getPaymentUrl());

现在，我们见告 PSP 通过 HTTPS 调用此隧道 URL。
只要 PSP 通过隧道调用 webhook，ngrok 将确保利用未修正的有效负载调用内部 URL。

如何监控对 webhook 的调用？

你在上面看到的屏幕截图概述了对隧道主机的调用，这些数据相称有限。
幸运的是，ngrok 供应了一个非常好的仪表板，许可你检讨所有调用：

我不会深入研究这个问题，由于它是不言自明的，你只要运行它就行了。
因此，我将阐明如何在 Vagrant 虚拟机上访问它，由于它不是开箱即用的。

仪表板将许可你查看所有调用、其状态代码、标头和发送的数据。
你将看到运用程序天生的相应。

仪表板的另一个优点是它许可你重放某个调用。
假设你的 webhook 代码碰着了致命的缺点，开始新的付款并等待 webhook 被调用将会很繁琐。
重放上一个调用可以使你的开拓过程更快。

默认情形下，仪表板可在 http://localhost:4040 访问。

虚拟机中的仪表盘

为了在 VM 中完成此事情，你必须实行一些额外的步骤：

首先，确保可以在端口 4040 上访问 VM。
然后，在 VM 内创建一个文件已存放此配置：

web_addr: 0.0.0.0:4040

现在，杀去世仍在运行的 ngrok 进程，并利用轻微调度过的命令启动它：