datenkraft / bb-price-assessment-api-php-client

价格评估API PHP客户端使您能够使用价格评估API。

v2.3.10 2024-01-18 11:33 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-price-assessment-api-php-client "~1.2.0"

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

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

使用库

该库可用于与价格评估资源服务器通信。客户端包括openapi.json中定义的每个端点的功能。客户端还使用openapi.json文件自动生成。

创建客户端

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);

示例端点:获取价格集合

$skuCodes = ["sku1" , "sku2" , "sku3"];  // array
$queryParams = ['filter[skuCode]' => $skuCodes];

$response = $client->getPriceCollection($queryParams);

$response; // price

许可

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