datenkraft/bb-authentication-api-php-client

认证 API PHP 客户端使您能够与认证 API 一起工作

v1.3.16 2024-01-22 16:21 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-authentication-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 许可证 下使用。