datenkraft/bb-fulfillment-api-php-client

履行API PHP客户端允许您与履行API一起工作

v2.3.89 2024-09-26 09:13 UTC

README

介绍

履行API PHP客户端允许您与履行API一起工作。

此PHP包由API客户端生成器生成。

先决条件

  • 生产环境需要PHP 8.0或更高版本

版本控制

本项目使用以下版本控制格式

v<APIMajorVersion>.<BaseClientMajorVersion>.<ApiIncrementalUpdateVersion>
  • APIMajorVersion:与客户端旨在使用的API的主版本匹配。
  • BaseClientMajorVersion:是特定于客户端的版本。此级别中的更改也意味着破坏性更改,与经典的SemVer格式不同。
  • ApiIncrementalUpdateVersion:每次发布时都会增加。

安装

您可以使用Composer。如果您尚未安装Composer,请遵循安装说明

如前文版本控制段落所述,前两个版本部分可能发生破坏性更改,因此建议使用以下示例中的require约束来保持在1.2内,而不是升级到1.3或更高版本。

如果您想使用v1 API,请使用客户端版本v1.X.0,其中X被替换为最高可用的发布号。

# Example
composer require datenkraft/bb-fulfillment-api-php-client "~1.2.0"

在您的PHP脚本中,请确保包含自动加载器

require 'path/to/vendor/autoload.php';

使用库

该库可用于与履行资源服务器通信。客户端包括openapi.json中定义的每个端点的功能。客户端还使用openapi.json文件由jane-php自动生成。

创建客户端

require 'path/to/vendor/autoload.php';

// Valid clientId, clientSecret and requested scopes
$clientId = '1234';
$clientSecret = 'abcd';

$config['clientId'] = $clientId;
$config['clientSecret'] = $clientSecret;

$factory = new ClientFactory($config);
$client = Client::createWithFactory($factory);

许可证

此存储库在MIT许可证下可用。