README

需求

要使用Ominity API客户端，需要以下条件

PHP >= 7.0
更新的OpenSSL（或其他SSL/TLS工具包）

安装

使用Composer

安装Ominity API客户端最简单的方法是使用Composer。您可以使用以下命令要求它

composer require ominity/ominity-api-php

手动安装

如果您不熟悉使用Composer，我们已经在发布中添加了一个ZIP文件，包含API客户端和Composer通常安装的所有包。从发布页面下载ominity-api-php.zip。

包含vendor/autoload.php

使用

初始化Ominity API客户端，并设置您的端点和API密钥。

$ominity = new \Ominity\Api\OminityApiClient();
$ominity->setApiEndpoint("https://ominity.example.com/api");
$ominity->setApiKey("q48fd94qs98fd4sqf89fza9sqd89f4");

使用OminityApiClient，您现在可以通过选择客户端的属性来访问以下任何端点

启用调试模式

在故障排除时，能够访问在ApiException中提交的请求是非常有益的。为了防止意外地在本地应用程序日志中暴露敏感请求数据，调试功能最初是关闭的。

要启用调试并检查请求

/** @var $ominity \Ominity\Api\OminityApiClient */
$ominity->enableDebugging();

try {
    $ominity->commerce->products->get(1);
} catch (\Ominity\Api\Exceptions\ApiException $exception) {
    $request = $exception->getRequest();
}

如果您正在记录ApiException的实例，请求详情将包含在日志中。确保这些日志中不保留任何敏感信息，并在调试完成后进行清理至关重要。

要再次禁用调试

/** @var $ominity \Ominity\Api\OminityApiClient */
$ominity->disableDebugging();

ominity / ominity-api-php

维护者

详细信息

README

需求

安装

使用Composer

手动安装

使用

启用调试模式

许可证