README

这是 Utrust API 的官方 PHP 库。[Utrust API 文档](https://docs.api.utrust.com)。

最低要求

• PHP 版本 5.4 或更高。

安装

使用 composer 安装

composer require utrust/utrust

使用方法

API 客户端

创建新的订单

use AbumUtrust\ApiClient;

$utrustApi = new ApiClient('API_KEY');

$orderData = [...];
$customerData = [...];

$response = $utrustApi->createOrder($orderData, $customerData);
echo $response->attributes->redirect_url;

查看完整示例 在此。

验证

可以使用 Validator 类在将数据数组传递给 API 客户端之前检查它。如果验证未通过，它将抛出一个包含错误数组的异常，否则它将返回 true

$orderIsValid = Validator::order($orderData);
$customerIsValid = Validator::customer($customerData);

if ($orderIsValid && $customerIsValid) {
    // create the order here
}

Webhooks

可以使用 Webhook\Event 类通过 Webhook 验证传入的事件。如果事件格式无效或签名无效，它将抛出一个异常

$event = new Event($payload);
$event->validateSignature($webhooksSecret);

查看 examples/ 目录以获取更多详细信息。

贡献

这个库是由 Utrust 开发团队编写和维护的。我们现在将其向世界开放，以便使用这个库的社区有机会塑造其发展。

您可以通过在 GitHub 上打开一个问题提出您的建议或任何您发现的问题来贡献。

您还可以在 GitHub 上分叉存储库并为您缺失的功能和/或错误修复打开一个针对 master 分支的 pull request。请确保新代码遵循已编写代码相同的样式和约定。我们的团队热切希望欢迎新的贡献者加入 😊。

测试

当贡献新的更改时，请努力提供相应的测试。这在修复任何问题时尤其重要，因为它将防止其他贡献者在未来意外地重新引入该问题。

在提交包含您更改的 pull request 之前，请确保每个测试都通过

composer test

当您不确定是否导致测试失败时，请检查 CircleCI 上的 master 构建是否失败。

代码风格检查

该项目使用 PHPCodeSniffer 和 PSR-2 编码标准。

在贡献您的更改之前，请确保它通过了代码风格检查

composer lint

当您不确定是否引入了代码风格错误时，请检查 CircleCI 上的 master 构建是否失败。

发布

我们将库发布到 Packagist。我们使用 语义版本化 来跟踪包更改。要发布新包版本，请运行以下命令

git tag v1.0.0
git push origin v1.0.0

许可证

Utrust PHP 由 Utrust 开发团队用 💜 维护，并可在 GNU GPLv3 许可证下向公众提供。有关更多信息，请参阅 LICENSE。

© Utrust 2020