acrolinx / sdk
Acrolinx 的 PHP SDK(无侧边栏)
v1.0.5
2022-11-15 12:09 UTC
Requires
- php: >=8.0
- ext-curl: *
- ext-json: *
- monolog/monolog: ^2.8.0
- myclabs/php-enum: ^1.7
- psr/log: ^1.1.4
- ramsey/uuid: ^4.2.3
- react/event-loop: ^1.3.0
- react/http: ^1.8
- react/promise: ^2.9.0
Requires (Dev)
- phpunit/phpunit: ^9
- victorjonsson/markdowndocs: ^1.3
- vlucas/phpdotenv: ^3.3
README
此库旨在用于在自动化集成中与 Acrolinx 平台 API 交互。
开始您的集成
先决条件
请联系 Acrolinx SDK 支持 进行咨询并获得您的集成认证。此 SDK 中的测试与内部 Acrolinx URL 上的测试许可证一起工作。此许可证仅供演示和开发目的。一旦您完成集成,您将需要从 Acrolinx 获取您的集成许可证。
Acrolinx 提供其他不同的 SDK 和开发集成示例。
在您开始开发自己的集成之前,您可能需要查看
- 使用 Acrolinx 构建,
- Acrolinx 集成开发指南,
- Acrolinx 平台 API
- Acrolinx 平台 API 渲染版本
- Acrolinx SDK,以及
- Acrolinx 示例项目。
开始开发
composer require acrolinx/sdk
使用 AcrolinxEndpoint
方法与 Acrolinx 平台 API 交互。
我们的 测试 已经涵盖了大量的用例。请使用它们作为灵感。
为此 SDK 做出贡献
先决条件
- 已安装 PHP 8.0 或更高版本
- 已安装 php-curl
- 已安装 composer 在此找到教程。
开始开发
- 运行
composer install
以安装依赖项 - 运行
composer update
以更新依赖项
运行测试
- 将
.env.conf
文件重命名为.env
- 在此文件中设置
ACROLINX_TEST_SERVER_URL
和ACROLINX_ACCESS_TOKEN
。(获取访问令牌) - 设置
ACROLINX_SSO_USER
和ACROLINX_SSO_PASSWORD
(您可以从 Acrolinx 支持处请求 SSO 密码) - 将
ACROLINX_DEV_SIGNATURE
设置为您集成提供的唯一签名。(注意:签名和访问令牌不同) - 运行
composer test
以运行单元测试
许可证
版权所有 2019-2023 Acrolinx GmbH
根据 Apache License 2.0 许可(“许可证”);除非遵守许可证规定或以书面形式同意,否则不得使用此文件。您可以在以下位置获取许可证副本:
https://apache.ac.cn/licenses/LICENSE-2.0
除非适用法律要求或书面同意,否则在许可证下分发的软件按“原样”提供,不提供任何明示或暗示的保证或条件。有关许可证的具体语言和限制,请参阅许可证。
更多信息请访问:https://www.acrolinx.com