README

PHP 客户端用于 Oxxa API.

支持

此客户端由 Cyberfusion 编写。已开源供社区使用。如有任何问题，请在 GitHub 上创建一个问题或发送电子邮件至 support@cyberfusion.nl。

此客户端不受 Oxxa 支持。

要求

此客户端需要 PHP 8.1 或更高版本以及默认 PHP 模块。

安装

此客户端可以用于任何 PHP 项目和任何框架。

使用 Composer 安装客户端

composer require cyberfusion/oxxa-api-client

用法

入门

// Initialize the API
$oxxa = new Oxxa($username, $password);

// Perform calls to an endpoint
$available = $oxxa
    ->domain()
    ->check('cyberfusion.nl');

测试模式

要测试您的实现，请使用测试模式。所有请求都告诉 Oxxa API 该请求是测试。

启用

$oxxa->enableTestMode();

禁用

$oxxa->disableTestMode();

模拟服务器

当使用模拟服务器进行测试时，您可以使用以下方法修改 API 的基本 URL：

$oxxa->setBaseUri('https://:8080');

这将返回 Oxxa 实例，因此您可以与其他方法一起使用它。

异常

在发生错误的情况下，客户端使用 OxxaException 作为基类抛出异常。所有异常都有一个特定的代码。这些可以在 OxxaException 类中找到。

测试

单元测试在 tests 目录中可用。运行

composer test

要生成 build/report 目录中的代码覆盖率报告，运行

composer test-coverage

贡献

一些基本端点已实现，但仍有很多未实现。请随时贡献！请参阅贡献指南。

安全

如果您发现任何与安全相关的问题，请通过电子邮件 support@cyberfusion.nl 联系，而不是使用问题跟踪器。

许可

此客户端是开源软件，根据 MIT 许可证许可。

cyberfusion / oxxa-api-client

维护者

详细信息

README

支持

要求

安装

用法

入门

测试模式

模拟服务器

异常

测试

贡献

安全

许可