datenkraft / bb-fulfillment-shopify-service-php-client
Fulfillment Shopify Service PHP 客户端允许您与 Fulfillment Shopify Service 进行交互
v1.3.16
2024-03-12 06:56 UTC
Requires
- php: ^8.0
- datenkraft/bb-base-api-php-client: ^3.0.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.16
- jane-php/open-api-3: ^7.5.0
- pact-foundation/pact-php: ^7.1
- phpunit/phpunit: ^9.6
- squizlabs/php_codesniffer: ^3.7
README
介绍
Fulfillment Shopify Service PHP 客户端允许您与 Fulfillment Shopify Service 进行交互。
此 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-shopify-service-php-client "~1.2.0"
在您的 PHP 脚本中,请确保包含自动加载器
require 'path/to/vendor/autoload.php';
使用库
此库可用于与 Fulfillment Shopify Service 资源服务器进行通信。客户端包括对在 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 许可证 下使用。