Bigcommerce API Client 技术文档

本文档将详细介绍如何安装、使用 Bigcommerce API Client，并提供项目 API 的使用指南。

1. 安装指南

要安装 Bigcommerce API Client，您需要使用 Composer。Composer 是 PHP 的依赖管理工具，可以帮助您管理项目中的依赖关系。

首先，确保您的 PHP 环境版本为 8.1 或更高，并且已启用 curl 扩展。

然后，在命令行中执行以下命令：

composer require bigcommerce/api
composer update

如果您需要为特定项目安装 Composer，可以进入项目库文件夹，并执行以下命令：

curl -sS https://getcomposer.org/installer | php
php composer.phar install
composer install

2. 项目使用说明

在您的 PHP 代码中使用 API 客户端时，确保您能够在自动加载路径中访问 Bigcommerce\Api。推荐使用 Composer 的 vendor/autoload.php 挂钩。

以下是如何配置和使用 Bigcommerce API Client 的示例：

OAuth 配置

$object = new \stdClass();
$object->client_id = 'xxxxxx';
$object->client_secret = 'xxxxx';
$object->redirect_uri = 'https://app.com/redirect';
$object->code = $request->get('code');
$object->context = $request->get('context');
$object->scope = $request->get('scope');

$authTokenResponse = Bigcommerce::getAuthToken($object);

Bigcommerce::configure([
    'client_id' => 'xxxxxxxx',
    'auth_token' => $authTokenResponse->access_token,
    'store_hash' => 'xxxxxxx'
]);

基本认证（已弃用）

Bigcommerce::configure([
    'store_url' => 'https://store.mybigcommerce.com',
    'username'  => 'admin',
    'api_key'   => 'd81aada4xc34xx3e18f0xxxx7f36ca'
]);

连接到商店

$ping = Bigcommerce::getStoreTime();

if ($ping) echo $ping->format('H:i:s');

访问集合和资源（GET）

$products = Bigcommerce::getProducts();

foreach ($products as $product) {
    echo $product->name;
    echo $product->price;
}

分页和过滤

$filter = ['page' => 3, 'limit' => 30];

$products = Bigcommerce::getProducts($filter);

更新现有资源（PUT）

$product = Bigcommerce::getProduct(11);

$product->name = 'MacBook Air';
$product->price = 99.95;
$product->update();

创建新资源（POST）

$fields = [
    'name' => 'Apple'
];

Bigcommerce::createBrand($fields);

删除资源和集合（DELETE）

$category = Bigcommerce::getCategory(22);
$category->delete();

3. 项目 API 使用文档

以下是一些基本的 API 使用示例：

使用 XML API

默认情况下，API 客户端会处理请求和响应，将 JSON 字符串转换为 PHP 对象表示。如果您需要使用 XML，可以通过 useXml 方法将 API 切换到 XML 模式。

Bigcommerce::useXml();

$xml = '<?xml version="1.0" encoding="UTF-8"?>
        <brand>
          <name>Apple</name>
          <search_keywords>computers laptops</search_keywords>
        </brand>';

$result = Bigcommerce::createBrand($xml);

错误和超时处理

如果 HTTP 请求失败，每个方法都会返回 false。在处理方法调用结果之前，您应该始终检查这一点。

$orders = Bigcommerce::getOrders();

if (!$orders) {
    $error = Bigcommerce::getLastError();
    echo $error->code;
    echo $error->message;
}

4. 项目安装方式

除了使用 Composer 安装外，还可以通过以下方式安装：

curl -sS https://getcomposer.org/installer | php
php composer.phar install
composer install

以上就是 Bigcommerce API Client 的安装指南和基本使用说明。希望这对您有所帮助！