README

PHP 客户端用于 Kaufland.de 在线商店 API。

安装

通过 Composer

$ composer require hitmeister/api-sdk

通过 GitHub

$ git clone git@github.com:hitmeister/api-sdk-php.git

快速入门

本节将为您快速概述客户端及其主要功能的工作方式。

创建客户端

开始之前，您需要从您的 API 设置页面 获取 API 密钥。同时，请将您的合作伙伴解决方案名称提供给 setUserAgent() 字段。

在您的主项目中包含自动加载器（如果您还没有这样做），并实例化一个新的客户端。

require 'vendor/autoload.php';

use Hitmeister\Component\Api\ClientBuilder;

$client = ClientBuilder::create()
	->setClientKey('YOUR_CLIENT_KEY')
	->setClientSecret('YOUR_CLIENT_SECRET')
	->setUserAgent('YOUR_USER_AGENT')
	->build();

命名空间概述

客户端有几个 "命名空间"，通常暴露 API 功能。命名空间对应于各种 API 端点。这是命名空间的完整列表

检索类别数据

您可以搜索类别

$categories = $client->categories()->find('handy');
foreach ($categories as $category) {
	echo "Category ID: {$category->id_category}\n";
	echo "Category Name: {$category->name}\n";
}

或者获取其中一个的信息

$category = $client->categories()->get(1);
echo "Category ID: {$category->id_category}\n";
echo "Category Name: {$category->name}\n";

检索产品数据

搜索项目

$items = $client->items()->find('iphone');
foreach ($items as $item) {
	$eans = implode(',', $item->eans);
	echo "Item ID: {$item->id_item}\n";
	echo "Category ID: {$item->id_category}\n";
	echo "Title: {$item->title}\n";
	echo "EANs: {$eans}\n";
}

您还可以通过 EAN 查找项目

$items = $client->items()->findByEan('0885909781652');

发送库存数据

根据 API 文档，您有两种选择

上传您的产品数据作为 CSV 文件

// Post the task to import your file. You will have the ID of the task.
$importFileId = $client->importFiles()
	->post('http://www.example.com/my_products.csv', 'PRODUCT_FEED');

// Retrieve the information about your task
$data = $client->importFiles()->get($importFileId);
echo "URL: {$data->uri}\n";
echo "Status: {$data->status}\n";

更新单个单元

// $result will be true or false
$result = $client->units()->update(10, ['condition' => 'new']);

测试

$ composer test

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅 许可证文件。