textcontrol / textcontrol-reportingcloud
ReportingCloud Web API 的 PHP SDK。由 Text Control GmbH 编写并支持。
Requires
- php: ^8.3
- ext-dom: *
- ext-json: *
- ext-libxml: *
- ctw/ctw-http: ^4.0
- guzzlehttp/guzzle: ^7.0
- psr/container: ^1.0 || ^2.0
Requires (Dev)
- ctw/ctw-qa: ^4.0
- fakerphp/faker: ^1.14
- phpstan/phpstan-phpunit: ^1.1
- phpunit/phpunit: ^10.0
- riimu/kit-phpencoder: ^2.4
- smalot/pdfparser: ^0.14
- symfony/var-dumper: ^7.0
README
ReportingCloud PHP SDK
这是 ReportingCloud Web API 的官方 PHP SDK。由 Text Control GmbH 编写并支持。
在以下网站了解更多关于 ReportingCloud 的信息
在以下网站了解更多关于 ReportingCloud PHP SDK 的信息
最低要求
截至 ReportingCloud PHP SDK 4.0，PHP SDK 需要 PHP 8.1 或 PHP 8.2。
所有早于 8.1 的 PHP 版本都已达到 生命周期的结束，将不再接收安全更新。如果您在旧环境中运行应用程序，强烈建议您升级到更近版本的 PHP。
如果您无法或不愿意升级 PHP 安装，您可以考虑使用 ReportingCloud PHP SDK 3.0，它支持 PHP 8.0，ReportingCloud PHP SDK 2.0，它支持 PHP 7.1，或者 ReportingCloud PHP SDK 1.0，它支持 PHP 5.6。
请注意，这些版本不再维护。
或者，您可以直接通过访问 Web API 来使用 ReportingCloud。在这种情况下，建议使用 curl 扩展来执行 API 调用。
使用 Composer 安装
使用 Composer 在您的项目中安装 ReportingCloud PHP SDK 4.0
composer require textcontrol/textcontrol-reportingcloud:^4.0
安装后，您只需包含 Composer 的自动加载器
include_once 'vendor/autoload.php';
现在您已经准备好使用 SDK 了。
演示和单元测试的 API 密钥
ReportingCloud PHP SDK 配备了一些示例应用程序（请参阅 /demo 目录）和 phpunit 测试（请参阅 /test 目录）。这些目录中的脚本需要 ReportingCloud 的 API 密钥 才能运行。为了避免意外通过公开的 GIT 仓库泄露 API 密钥，您需要先指定它。有两种方法可以做到这一点
使用 PHP 常量
define('REPORTING_CLOUD_API_KEY', 'your-api-key');
使用环境变量（例如在 .bashrc 中）
export REPORTING_CLOUD_API_KEY='your-api-key'
请注意，这些说明仅适用于演示脚本和 phpunit 测试。如果您在自己的应用程序中使用 ReportingCloud，请通过构造函数或使用 setApiKey($apiKey) 方法设置 API 密钥。有关示例，请参阅 /demo/instantiation.php。
入门指南
ReportingCloud 文档 中的 PHP 快速入门教程 是您在应用程序中使用 ReportingCloud PHP SDK 的起点。
此外，ReportingCloud PHP SDK 包含一些示例应用程序（请参阅 /demo 目录）。这些注释良好的示例应用程序旨在展示 ReportingCloud 的所有功能。
获取支持
ReportingCloud PHP SDK 由 ReportingCloud Web API 的制造商 Text Control GmbH 编写并支持。
尽管我们尽力创建易于理解的文档、示例应用程序和单元测试，但我们理解有时您可能需要技术支持。
如果您对 ReportingCloud 或 PHP SDK 有任何疑问，我们愿意提供帮助。