noxxie/mailtopay-api

Mailtopay API 的 PHP API 接口

0.1.3 2019-12-28 11:00 UTC

This package is auto-updated.

Last update: 2024-08-28 21:11:52 UTC


README

此包旨在使 MailtoPay API 与 PHP 之间的接口更容易使用。此包只能与 Mailtopay API 的版本 2 一起使用,版本 1 不受支持,并由 Mailtopay 废弃。

有关 Mailtopay API 的更多信息,可以在 Mailtopay 网站上找到

此项目处于公开测试阶段,请使用问题跟踪器报告任何错误。

需求

  • PHP >= 5.3.7

安装

composer require noxxie/mailtopay-api

安装后,您可以使用任何给定的 endpoint 类,并使用 client 类进行请求。有关端点的更多信息,请参阅 docs 目录。

用法

有关每个端点的信息,请参阅 docs 目录。您可以使用 client 类进行实际请求。

use Noxxie\Mailtopay\Client;
...

$client = new Client('id', 'passphrase', 'base_uri', $endpoint);
$response = $client->execute();

idpassphrasebase_uri 是 Mailtopay 提供的信息。

验证

此包旨在在可能的情况下尽可能验证提供的任何数据,以便在请求发送到 API 之前返回无效数据。当设置无效参数时,将抛出 InvalidParameterException 异常。

但是,您输入的数据组合可能非常奇怪,此包无法验证。API 也会进行验证检查,如果 API 发生错误,则返回错误响应。您可以使用 ResponseException 异常捕获这些错误。

测试

使用 phpunit 运行测试

.\vendor\bin\phpunit

版本控制

我们使用 SemVer 进行版本控制。

作者

许可

本项目采用 MIT 许可证 - 有关详细信息,请参阅 LICENSE 文件