README

简介

SKU 使用 API PHP 客户端使您能够使用 SKU 使用 API。

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

先决条件

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

版本控制

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

v<APIMajorVersion>.<BaseClientMajorVersion>.<ApiIncrementalUpdateVersion>

• APIMajorVersion：与客户端旨在使用的 API 的主版本相匹配。
• BaseClientMajorVersion：是客户端特定的版本。此级别的变化也意味着破坏性变化，这与经典的 SemVer 格式不同。
• ApiIncrementalUpdateVersion：每次发布时都会增加。

安装

您可以使用 Composer。如果您尚未安装 composer，请按照 安装说明 进行操作。

如前文版本控制段落所述，第一和第二版本部分可能会出现破坏性变化，因此建议使用以下所示的要求约束，保持 1.2 而不升级到 1.3 或更高版本。

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

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

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

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

使用库

此库可用于与 SKU 使用资源服务器进行通信。客户端包括对 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);

示例端点：添加 SKU 使用

$data = [];

$skuUsageMeta = [
    'description' => 'description',
    'amount' => 99.9,
    'currency' => 'EUR',
];

$skuUsage = new NewSkuUsage();
$skuUsage->setExternalId('12')
    ->setMeta($skuUsageMeta)
    ->setProjectId('26e6a22f-6cb1-456a-861e-fde46e3988b2')
    ->setQuantity(1)
    ->setSkuCode('ab')
    ->setUsageEnd(new \DateTime())
    ->setUsageStart(new \DateTime());

$skuUsage2 = new NewSkuUsage();
$skuUsage->setExternalId('14')
    ->setProjectId('6ea1cb54-3a78-46b8-90ab-300b2eaef9dd')
    ->setQuantity(1)
    ->setSkuCode('newab')
    ->setUsageEnd(new \DateTime())
    ->setUsageStart(new \DateTime());

$data = [$skuUsage, $skuUsage2];
$response = $client->addSkuUsage($data);
$response; // skuUsage[]

许可证

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