README

Bigcommerce PHP API 的包装包。

包安装

将以下行添加到您的 composer.json 文件中

"kalley/laravel-bigcommerce": "dev-master"

或者从命令行运行 composer require kalley/laravel-bigcommerce:dev-master

将以下行代码添加到您的 app/config/app.php 文件中的 providers 数组中

'Kalley\LaravelBigcommerce\LaravelBigcommerceServiceProvider',

并将以下行添加到 aliases 数组

'Bigcommerce' => 'Kalley\LaravelBigcommerce\Client',

配置

为了使用 Bigcommerce API，首先发布其配置。

php artisan config:publish kalley/laravel-bigcommerce

之后编辑 app/config/packages/kalley/laravel-bigcommerce/bigcommerce.php 文件以满足您的需求。

迁移

此包包含您运行完整功能的 OAuth2 服务器所需的所有迁移。运行

php artisan bigcommerce:migrations

然后您就可以开始了！查看 Bigcommerce PHP API 了解如何使用此库的详细信息。

缓存

如果配置了缓存，此库将缓存任何 GET API 调用的结果。除非您传递 false 作为最后一个参数，否则它将始终缓存添加的方法的结果。

cache 配置选项接受一个表示分钟数的整数（例如，10）；false、null、0 表示不缓存；或 'forever' 表示永久缓存。任何其他值都将被视为不缓存结果的标志。与以下添加的方法一样，您可以通过传递布尔值作为最后一个参数来强制再次缓存，如果需要的话。

扩展

在此库中，当缓存结果（如果配置了缓存）时，会传递现有的 Bigcommerce\Api\Client 方法。它还包括以下方法

Bigcommerce::createCustomerAddress($customer_id, $object);

这将在您的店铺客户地址簿中创建一个地址。所需字段如下

• first_name
• last_name
• phone
• street_1
• city
• state
• zip
• country - 这需要与 Bigcommerce 预期的一致。请参阅以下内容。

Bigcommerce::getCountries($filter=false, $force=false);

这将为您提供 Bigcommerce 支持的国家列表或类似的内容。为您缓存它，这样您就不会耗尽您的 API 限制。

返回一个包含 \Bigcommerce\Api\Resource 的数组

Bigcommerce::getCountry($id);

如果您出于任何原因想获取单个国家的信息。

返回一个 \Bigcommerce\Api\Resource 实例

Bigcommerce::getCountryStates($country_id, $filter=false, $force=false);

获取请求国家的州/省信息。为您缓存它，这样您就不会耗尽您的 API 限制。

返回一个包含 \Bigcommerce\Api\Resource 的数组

Bigcommerce::getCountryState($country_id, $id);

如果您出于任何原因想获取单个州的信息。

返回一个 \Bigcommerce\Api\Resource 实例

支持

错误和功能请求在 GitHub 上跟踪

许可证

此包在 MIT 许可证下发布。