onesend-gmbh / onesend-php-sdk
OneSend 消息服务的 PHP SDK
1.0.2
2024-04-18 14:16 UTC
Requires
- php: >=8.2
- nyholm/psr7: ^1.8
- php-http/discovery: ^1.0
- php-http/httplug: ^2.0
- php-http/message-factory: ^1.0
- psr/http-client-implementation: ^1.0
- psr/http-message: ^1.0 | ^2.0
- symfony/http-client: ^7.0|^6.4
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.54
- php-http/message: ^1.0
- php-http/mock-client: ^1.0
- phpunit/phpunit: ^11.1
README
需求
要使用 OneSend PHP SDK,需要以下条件
- 一个免费的 OneSend 账户(要实际发送消息,您需要向您的账户添加余额)
- PHP >= 8.2
- 可选:一个符合 PSR-18 的 HTTP 客户端 PSR-18 compliant HTTP Client,默认情况下将使用 Symfony Http Client
安装
使用 Composer
安装 OneSend PHP SDK 的最佳方式是使用 Composer。您可以使用以下命令要求它
composer require onesend-gmbh/onesend-php-sdk
用法
通过传递您的 项目仪表板 中的 Api Key 来初始化 SDK。
$oneSend = new \OnesendGmbh\OnesendPhpSdk\OneSendApi('YOUR KEY HERE');
可选地,您还可以传递一个 PSR-18 合规的客户端作为第二个参数,如果您想修改超时/重试行为或进行测试。
使用 SDK,您现在可以访问以下端点
您可以在 这里 找到我们的完整文档。
短消息
发送短消息(SMS)
$shortMessage = $oneSend->shortMessages->send([ 'to' => '+4915730955123', 'from' => 'TEST', 'message' => 'THIS IS A TEST', ]);
这将创建一个 ShortMessage 资源,具有消息 ID $shortMessage->getId()
您可以和一些关于已发送的短消息的其他信息。
测试
默认情况下,SDK 将在初始化时将 Symfony Http Client 设置为 HTTP 客户端,这意味着如果您不模拟 SDK 的调用,它将向我们的服务发送请求,并且您的测试很可能会失败。
如果您不想(或不能)模拟 SDK 的调用,您还可以通过将 Mock 客户端(例如 PHP HTTP Mock Client)作为第二个构造函数参数传递来替换默认的 HTTP 客户端
$mockClient = new Http\Mock\Client(); $oneSend = new \OnesendGmbh\OnesendPhpSdk\OneSendApi('I am a Test', $mockClient);
这将替换默认的 Http 客户端,并允许您拦截并验证 SDK 发出的请求,以及模拟具有期望结果的响应。
要查看预期的响应,请参阅我们的 API 文档。