README

在 Laravel php 框架中处理 PayPal webhooks。

安装

您可以通过 composer 安装此包

composer require "Tommmoe/laravel-paypal-webhooks"

服务提供程序将自动注册自己。

您必须使用以下命令发布配置文件

php artisan vendor:publish --provider="Tommmoe\PayPalWebhooks\PayPalWebhooksServiceProvider"

接下来，您必须使用以下命令发布迁移

php artisan vendor:publish --provider="Spatie\WebhookClient\WebhookClientServiceProvider" --tag="webhook-client-migrations"

迁移发布后，您可以通过运行迁移来创建 webhook_calls 表

php artisan migrate

接下来，对于路由，将此路由（访客）添加到您的 routes/web.php

Route::paypalWebhooks('/webhooks/paypal');

幕后，这将注册一个由此包提供的控制器的一个 POST 路由。接下来，您必须将此路由添加到 VerifyCsrfToken 中间件的 except 数组中

protected $except = [
    '/webhooks/*',
];

建议设置一个队列工作者来预先处理传入的 webhooks。

设置 PayPal 账户

登录 PayPal 开发者仪表板
创建一个新应用（推荐）
在新创建的应用下创建一个新的 Webhook
输入您的 webhook URL。💡您可以使用 ngrok 进行本地开发
选择要跟踪的事件（不要选择全部），例如
- 结账订单批准
保存后，您将看到一个 Webhook ID
在您的 .env 中指定此 webhook ID，例如

PAYPAL_WEBHOOK_ID=6U272633NC098611R

此 webhook ID 将用于验证传入请求的签名。

故障排除

在开发期间使用 ngrok 时，您必须更新您的 APP_URL 以匹配 ngrok 泛域名 URL，例如

APP_URL=https://af59-111-93-41-42.ngrok-free.app

您必须通过在终端访问 URL 来验证您的 webhook URL 是否公开可访问

curl -X POST https://af59-111-93-41-42.ngrok-free.app/webhooks/paypal

用法

有 2 种方式通过此包处理传入的 webhooks。

1 - 使用作业处理 webhook 请求

如果您想在特定事件类型到来时执行某些操作；您可以为此事件定义一个作业。以下是一个此类作业的示例

<?php

namespace App\Jobs\Webhook\PayPal;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\SerializesModels;
use Spatie\WebhookClient\Models\WebhookCall;

class CheckoutOrderApprovedJob implements ShouldQueue
{
    use SerializesModels;

    public function __construct(protected WebhookCall $webhookCall)
    {
        //
    }

    public function handle()
    {
        $message = $this->webhookCall->payload['resource'];
            
        // todo do something with $message['id']        
    }
}

创建您的作业后，您必须在 config/paypal-webhooks.php 配置文件的 jobs 数组中注册它。键必须为小写，点必须替换为 _。值必须是完全限定类名。

<?php

return [
     'jobs' => [
          'checkout_order_approved' => \App\Jobs\Webhook\PayPal\CheckoutOrderApprovedJob::class,
     ],
];

2 - 使用事件和监听器处理 webhook 请求

与其将作业排队以在 webhook 请求到来时执行某些工作，您可以选择监听此包将触发的事件。每当匹配的请求击中您的应用时，该包将触发一个 paypal-webhooks::<event-name> 事件。

事件的负载将是为传入请求创建的 WebhookCall 实例。

您可以通过在 EventServiceProvider 类中注册监听器来监听此类事件。

protected $listen = [
    'paypal-webhooks::payment_order_cancelled' => [
        App\Listeners\PayPal\PaymentOrderCancelledListener::class,
    ],
];

以下是一个此类监听器类的示例

<?php

namespace App\Listeners\PayPal;

use Illuminate\Contracts\Queue\ShouldQueue;
use Spatie\WebhookClient\Models\WebhookCall;

class PaymentOrderCancelledListener implements ShouldQueue
{
    public function handle(WebhookCall $webhookCall)
    {
        $message = $webhookCall->payload['resource'];
               
        // todo do something with $message        
    }
}

修剪旧 webhooks（可选但推荐）

更新您的 app/Console/Kernel.php 文件如下

use Illuminate\Database\Console\PruneCommand;
use Spatie\WebhookClient\Models\WebhookCall;

$schedule->command(PruneCommand::class, [
            '--model' => [WebhookCall::class]
        ])
        ->onOneServer()
        ->daily()
        ->description('Prune webhook_calls.');

这将删除超过 30 天的记录，您可以通过发布此配置文件来修改此持续时间。

php artisan vendor:publish --provider="Spatie\WebhookClient\WebhookClientServiceProvider" --tag="webhook-client-config"

变更日志

有关最近更改的更多信息，请参阅 CHANGELOG

测试

composer test

安全

如果您发现任何安全问题，请通过电子邮件 pro.ankurk1[at]gmail[dot]com 而不是使用问题跟踪器。

有用链接

https://developer.paypal.com/api/rest/webhooks/

致谢

本包高度受到以下项目的启发

https://github.com/spatie/laravel-stripe-webhooks

许可证

本包遵循MIT许可证。

tommmoe / laravel-paypal-webhooks

维护者

详细信息