README

概述

FINDOLOGIC-API 是 Findologic API 的面向对象包装器，包含超过 300 个自动单元测试和 100% 代码覆盖率。

这个库不仅帮助请求 Findologic API，还能从响应中获取数据并将它们映射到相应的对象。您再也不必在发送请求和从 Findologic 的响应中获取数据上浪费时间了。

您想要获取过滤器？只需调用 Response::getMainFilters()。真的非常简单，只需尝试 基本用法 或查看一些 示例。

为了更好地了解 API，请确保阅读一般 Findologic API 文档。我们已经为您准备好了快速链接。

• 请求 API
• 响应：XML | API 规范（非交互式）
• 响应：JSON | API 规范（交互式） | API 规范（非交互式）

限制

目前，我们支持以下响应格式

要求

• PHP >= 8.1
  • PHP curl 扩展（可选）
• Composer

安装

对于简单安装，您可以使用 Composer。使用此命令将安装最新版本。

composer require findologic/findologic-api

基本用法

使用非常简单。以下是一个示例

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

use FINDOLOGIC\Api\Config;
use FINDOLOGIC\Api\Client;
use FINDOLOGIC\Api\Requests\Request;
use FINDOLOGIC\Api\Requests\SearchNavigation\SearchRequest;
use FINDOLOGIC\Api\Responses\Json10\Json10Response;

// Set your ServiceId/Shopkey, which can be found in the customer account.
$config = new Config('ABCDABCDABCDABCDABCDABCDABCDABCD');
$client = new Client($config);

/** @var SearchRequest $request */
$request = Request::getInstance(Request::TYPE_SEARCH);
$request->setQuery('shirt') // Users search query.
    ->setShopUrl('blubbergurken.de') // Url of the shop.
    ->setUserIp('127.0.0.1') // Users IP.
    ->setReferer($_SERVER['HTTP_REFERER']) // Page where search was fired.
    ->setRevision('1.0.0') // Version of your API wrapper.
    ->setOutputAdapter('JSON_1.0'); // Optional setting of output format.

/** @var Json10Response $response */
$response = $client->send($request);

var_dump($response->getResult()->getItems()); // Get all products/items.
var_dump($response->getResult()->getMainFilters()); // Get all main filters easily.
var_dump($response->getResult()->getOtherFilters()); // Get all other filters easily.
var_dump($response); // Entire response, full of helper methods.

示例

• 工作示例可以在 /examples 目录中找到。
• 文档可以在我们的 项目 Wiki 中找到。

使用此库的项目

• FINDOLOGIC Shopware 6 插件
• FINDOLOGIC Shopware 5 插件
• 简单的 Symfony 5 示例（展示简单的 FINDOLOGIC-API 集成）
• 还有更多...

错误报告

我们需要您的帮助！如果您发现任何错误，请提交问题并使用我们的模板！请尽可能详细，以便我们更容易重现您的情况。有关更多信息，请参阅我们的 .github/ISSUE_TEMPLATE/bug_report.md 问题模板。

贡献

请查看我们的 贡献指南 了解如何贡献。