utrust / utrust
Utrust API 库
Requires
- php: >=5.3.0
- vlucas/valitron: ^1.4.7
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-19 11:57:34 UTC
README
这是Utrust API的官方PHP库。
最低要求
- PHP版本5.4或更高。
安装
使用composer安装
composer require utrust/utrust
用法
API客户端
创建新订单
use Utrust\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上fork存储库,并为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