digitalprint / oro-api-php
用于 PHP 应用程序的 OroCommerce API 客户端。
v1.2.0
2022-04-07 09:39 UTC
Requires
- php: >=8.0.2
- ext-curl: *
- ext-json: *
- ext-openssl: *
- composer/ca-bundle: ^1.2
Requires (Dev)
- eloquent/liberator: ^2.0
- friendsofphp/php-cs-fixer: ^3.7
- guzzlehttp/guzzle: ^6.3 || ^7.0
- phpunit/phpunit: ^5.7 || ^6.5 || ^7.1 || ^8.5 || ^9.5
README
感谢您使用 "OroCommerce Api PHP Client"(Digitalprint_Oro-Api-PHP)。
此包包含一些基本功能,您可以使用这些功能将 PHP 应用程序与您的 OroCommerce 系统连接。
此包仅包含少量端点。如果您有建议可以使此包变得更好,请分支仓库并创建一个拉取请求。您也可以简单地通过带有 "enhancement" 标签的问题来提出建议。
1. 文档
2. 安装方法
通过 composer 安装(推荐)
在您的根目录中运行以下命令
composer require digitalprint/oro-api-php
3. 用户指南
此包将 OroCommerce API 功能集成到您的 PHP 应用程序中。
3.1 入门
初始化 OroCommerce API 客户端。
$oro = new \Digitalprint\Oro\Api\OroApiClient(); $oro->setApiEndpoint('YOUR_ORO_API_ENDPOINT'); $oro->setUser('YOUR_ORO_API_USER'); $res = $oro->authorization->create([ 'client_id' => 'YOUR_CLIENT_ID', 'client_secret' => 'YOUR_CLIENT_SECRET', ]); $oro->setAccessToken($res->access_token);
3.2 产品示例
获取单个产品
$product = $oro->products->get(100);
获取包含相关实体的单个产品
$oro->products->get(1, ['include' => 'names,descriptions']);
获取产品列表
$products = $oro->products->page();
获取推荐产品列表
$products = $oro->products->page(1, 10, ['featured' => true]);
获取产品名称
$names = $oro->products->get(100)->names();
更新现有产品
$product = $oro->products->get(100); $res = $product->update([ 'data' => [ 'meta' => [ 'update' => true, ], 'type' => 'products', 'id' => $product->id, 'attributes' => [ 'status' => ($product->attributes->status === 'disabled' ? "enabled" : "disabled"), ], ], ]);
创建新产品
$product = $oro->products->create([ 'data' => [ 'type' => 'products', 'attributes' => [ 'sku' => 'test-api-' . strtotime('now'), 'status' => 'enabled', 'variantFields' => [], 'productType' => 'simple', 'featured' => true, 'newArrival' => false, 'availability_date' => '2018-01-01', ], 'relationships' => [ ... ], ], 'included' => [ ... ], ]);
删除单个产品
$names = $oro->products->get(100)->delete();
3.3 更多示例
更多示例在 示例文件夹 中