README

这是 Convoy PHP SDK。此 SDK 包含与 Convoy API 交互的方法。以下是入门示例。有关更多示例，请参阅我们的官方文档（https://convoy.readme.io/reference）。

安装

要安装此包，您需要在项目中使用 Composer。

Convoy PHP SDK 与任何 HTTP 客户端（如 Guzzle 或其他用于发送 HTTP 请求的库）没有硬耦合。HTTP 客户端实现基于 PSR-18。这为您提供了方便，可以选择您想要使用的 PSR-7 和 HTTP 客户端。

要快速入门，

composer require frain/convoy symfony/http-client nyholm/psr7

设置客户端

接下来，导入 convoy 模块，并使用您的认证凭据进行设置。

use Convoy\Convoy;

$convoy = new Convoy(["api_key" => "your_api_key", "project_id" => "your_project_id"]);

创建端点

端点表示接收事件的目标 URL。

$endpointData = [
    "name" => "Default Endpoint",
    "url" => "https://0d87-102-89-2-172.ngrok.io",
    "description" => "Default Endpoint",
    "secret" => "endpoint-secret",
    "events" => ["*"]
];

$response = $convoy->endpoints()->create($endpointData);

更新端点

$endpointId = "01GTVFSGBAH8NJTMT5Y1ENE218";

$endpointData = [
    "name" => "Default Endpoint",
    "url" => "https://0d87-102-89-2-172.ngrok.io",
    "description" => "Default Endpoint",
    "secret" => "endpoint-secret",
    "events" => ["*"]
];

$response = $convoy->endpoints()->update($endpointId, $endpointData);

发送事件

要发送事件，您需要我们之前创建的端点的 uid。

$eventData = [
    "endpoint_id" => $endpointId,
    "event_type" => "payment.success",
    "data" => [
        "event" => "payment.success",
        "data" => [
            "status" => "Completed",
            "description" => "Transaction Successful",
            "userID" => "test_user_id808"
        ]
    ]
];

$response = $convoy->events()->create($eventData);

测试

composer test

贡献

有关详细信息，请参阅 CONTRIBUTING。

致谢

• Frain

许可

MIT 许可证 (MIT)。有关更多信息，请参阅 许可文件。