metmax-io/cbr-api-php

CBR Top WSAPI客户端包装器

维护者

详细信息

github.com/MetMax-io/cbr-api-php

主页

源代码

问题

资助包维护！
MetMax

安装: 2

依赖项: 0

建议者: 0

安全性: 0

星星: 0

关注者: 1

分支: 2

公开问题: 2

dev-main 2023-07-03 10:27 UTC

Requires

Requires (Dev)

MIT 2be3af81c039052644b2ccfec9b39a218ea0050a

  • Jeroen de Haar <jeroen.woop@metmax.io>

MetMaxcbr-api-phpCBR Top

This package is not auto-updated.

Last update: 2024-09-25 15:57:17 UTC

README

Latest Version on Packagist Tests Total Downloads

一个用于与CBR Top Webservices API交互的PHP包装器，支持AuthenticationService、ReservationService、ReferenceDataService。这样，您可以处理以下操作：

  • 提交新应用程序或更改现有应用程序；
  • 请求开放应用程序；
  • 通过TOP请求之前购买的容量；
  • 在自己的容量下请求预留；
  • 请求结果；
  • 请求参考数据，例如允许的产品和位置、您的注册教练、您与其他教练的协议以及产品的可用语言；
  • 更改密码；

安装

您可以通过composer安装此包

composer require metmax-io/cbr-api-php

创建环境文件

cp .env.dist .env

使用方法

API由3个端点组成

  • 认证
  • 参考数据
  • 预订

API分散在不同的文件夹中，但可以使用类似的方式。

获取物理CBR位置列表

use MetMax\Cbr\ReferenceData\ReferenceDataClientFactory;
use MetMax\Cbr\ReferenceData\Type\LocationsRequest;

$referenceData = ReferenceDataClientFactory::factory('username', 'password');
$locations = $referenceData->getLocations(new LocationsRequest());

测试

该包使用php-http/vcr-plugin来模拟对CBR API的SOAP调用。响应将存储在fixtures/vcr/目录中。

当不存在测试文件时，将发起实际的HTTP调用，并将响应存储为测试文件。如果您想更新现有的测试文件或创建新的端点，请确保在.env文件中配置了API凭证。

运行完整测试套件

composer test

变更日志

有关最近更改的更多信息，请参阅CHANGELOG。

贡献

有关详细信息，请参阅CONTRIBUTING。

鸣谢

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。