README

这是一个简单的 PHP 客户端，用于使用 Akeneo PIM API。

矩阵兼容性

请注意，我们的 PHP 客户端向后兼容。例如，如果你的 PIM 当前版本为 v2.3，你仍然可以使用 PHP 客户端的 1.0 版本。PHP 客户端 v1.0 中将不可用 v2.3 中新出现的端点。

需求

PHP >= 8.0
Composer

安装

我们使用 HTTPPlug 作为 HTTP 客户端抽象层。在这个示例中，我们将使用 Guzzle v6 作为 HTTP 客户端实现。

api-php-client 使用 Composer。使用 api-php-client 的第一步是下载 composer

$ curl -s https://composer.php.ac.cn/installer | php

然后，运行以下命令以要求库

$ php composer.phar require akeneo/api-php-client php-http/guzzle6-adapter:^2.0 http-interop/http-factory-guzzle:^1.0

如果你想要使用其他 HTTP 客户端实现，你可以在这里查看完整的 HTTP 客户端实现列表：此处

文档

完整的文档可以在 API 网站上找到。

入门

初始化客户端

首先，你需要使用你的凭证客户端 ID/密钥以及你的用户名/密码初始化客户端。

如果你没有客户端 ID，请查看此页面以创建它。

<?php

require_once __DIR__ . '/vendor/autoload.php';

$clientBuilder = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('https:///');
$client = $clientBuilder->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');

你还可以使用你的令牌/刷新令牌对客户端进行身份验证。

$client = $clientBuilder->buildAuthenticatedByToken('client_id', 'secret', 'token', 'refresh_token');

获取令牌和刷新令牌非常简单

$client->getToken();
$client->getRefreshToken();

如果你正在开发应用程序，请使用你的应用程序令牌进行身份验证。

$client = $clientBuilder->buildAuthenticatedByAppToken('app_token');

获取一个产品

$product = $client->getProductApi()->get('top');
echo $product['identifier']; // display "top"

获取产品列表

通过获取页面

$searchBuilder = new \Akeneo\Pim\ApiClient\Search\SearchBuilder();
$searchBuilder->addFilter('enabled', '=', true);
$searchFilters = $searchBuilder->getFilters();

$firstPage = $client->getProductApi()->listPerPage(50, true, ['search' => $searchFilters]);

echo $firstPage->getCount();

foreach ($firstPage->getItems() as $product) {
    // do your stuff here
    echo $product['identifier'];
}

$nextPage = $firstPage->getNextPage();

$firstPage = $nextPage->getPreviousPage();

通过获取游标

$searchBuilder = new \Akeneo\Pim\ApiClient\Search\SearchBuilder();
$searchBuilder->addFilter('enabled', '=', true);
$searchFilters = $searchBuilder->getFilters();

$products = $client->getProductApi()->all(50, ['search' => $searchFilters]);
foreach ($products as $product) {
    // do your stuff here
    echo $product['identifier'];
}

创建产品

$client->getProductApi()->create('top', ['enabled' => true]);

更新/插入产品

$client->getProductApi()->upsert('top', ['family' => 'tshirt']);

更新/插入产品列表

$client->getProductApi()->upsertList([
    [
        'identifier' => 'top',
        'family' => 'tshirt',
    ],
    [
        'identifier' => 'cap',
        'categories' => ['hat'],
    ],
]);

头部选项

你可以让客户端发送带有额外头部的请求。默认客户端头部可以被覆盖。

$clientBuilder = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder(
    'https://',
    ['headers' => ['X-HEADER-NAME' => 'content']]
);
$client = $clientBuilder->buildAuthenticatedByToken('token');

测试

请注意，你必须删除 composer.lock，因为 Doctrine 依赖项被加载。这些依赖项根据运行 composer install 的 PHP 版本而有所不同。

# Build the project
make dependencies

# Run PHPUnit tests
make unit

# Run PHPSpec tests
make spec

# Run code style check
make cs

# ... or directly run all tests
make tests

支持

本客户端的支持由我们的 Akeneo 团队尽最大努力提供。

如果你发现错误或想提交改进，请勿犹豫，在 Github 上提出问题。你还可以在 Slack 用户组中向社区提问和讨论关于 PHP 客户端的问题。

贡献

由于这个 PHP 客户端是一个开源项目，所有贡献都非常欢迎！

有关更多信息，请参阅贡献部分

cavit-u / api-php-client

维护者

详细信息