dagar/convoy

convoy api 的 PHP 插件

v1.0.0 2024-09-05 06:21 UTC

This package is auto-updated.

Last update: 2024-09-05 06:22:35 UTC


README

Convoy Webhook 平台 PHP SDK 是一款强大的工具,它允许开发人员轻松地将 Convoy 的 webhook 功能集成到他们的 PHP 应用程序中。使用此 SDK,您可以轻松地发送和接收 webhook,处理事件和管理订阅。

功能

  • 易于集成:SDK 为将 Convoy 的 webhook 功能集成到您的 PHP 应用程序中提供了一种简单直观的界面。

  • webhook 管理:使用 SDK,您可以轻松地向外部服务发送 webhook 并从 Convoy 接收 webhook。

  • 事件处理:SDK 允许您处理传入的 webhook 事件并根据事件数据执行自定义操作。

  • 订阅管理:您可以管理您的 webhook 订阅,包括创建、更新和删除订阅。

安装

要安装 Convoy Webhook 平台 PHP SDK,只需运行以下命令

composer require dagar/convoy

使用方法

要开始使用 SDK,请按照以下步骤操作

  1. 将 SDK 导入您的 PHP 文件
require_once 'vendor/autoload.php';
use Dagar\Convoy\Api;
  1. 初始化 API 类
$authToken = 'CO.yjkKPKAa4FYGJNqo.81uZ3tWu7cLHv6twgkNFZKWmnyCMfa4b7i58Z48FVJTX0WGR9mNfX878Ps1BsoHm';
$url = "https://api.convoy.com";
$orgID = "01J6Y7JN7JEAE8X94RW4W5SDPE";
$projectId = "01J6Y8RZAKBAH4D2Y8CQP6305G";

$api = new Api($authToken, $url);
  1. 开始发送和接收 webhook
$resp = $api->Project()->Create('project_name', $orgID);
print_r($resp);

$resp = $api->Project()->List($orgID);
print_r($resp);

$resp = $api->Project($projectId)->Source()->List();
print_r($resp);

$resp = $api->Project($projectId)->Source()->Create('source_name');
print_r($resp);

$resp = $api->Project($projectId)->Endpoint()->List();
print_r($resp);

$resp = $api->Project($projectId)->Endpoint()->Create('webhook', "https://webhook.site/");
print_r($resp);

$resp = $api->Project($projectId)->Subscription()->List();
print_r($resp);

$resp = $api->Project($projectId)->Subscription()->Create('test', '01J6Y8RZAKBAH4D2Y8CQP6305G', '01J6Y8RZAKBAH4D2Y8CQP6305G');
print_r($resp);

有关更详细的使用说明和示例,请参阅 文档

贡献

我们欢迎社区贡献!如果您有任何建议、错误报告或功能请求,请在我们的 GitHub 仓库 上提交问题。

许可

此 SDK 根据 MIT 许可证 发布。