PHPackages findologic/findologic-api - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. findologic/findologic-api ActiveLibrary[API Development](/categories/api) findologic/findologic-api ========================= Library for FINDOLOGIC API requests v2.0.0(2y ago)1104.6k↓31%3[4 issues](https://github.com/findologic/findologic-api/issues)[1 PRs](https://github.com/findologic/findologic-api/pulls)1MITPHPPHP >=8.1 Since Feb 4Pushed 2y ago4 watchersCompare [ Source](https://github.com/findologic/findologic-api)[ Packagist](https://packagist.org/packages/findologic/findologic-api)[ RSS](/packages/findologic-findologic-api/feed)WikiDiscussions develop Synced 1mo ago READMEChangelog (10)Dependencies (5)Versions (30)Used By (1) FINDOLOGIC-API ============== [](#findologic-api) [![Tests](https://github.com/findologic/findologic-api/actions/workflows/phpunit.yml/badge.svg)](https://github.com/findologic/findologic-api/actions/workflows/phpunit.yml)[![codecov](https://camo.githubusercontent.com/ecf2c80651dfa934db048e3bb0033131941475b132c1681de0b874e0d1a90a38/68747470733a2f2f636f6465636f762e696f2f67682f66696e646f6c6f6769632f66696e646f6c6f6769632d6170692f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/findologic/findologic-api)[![Packagist](https://camo.githubusercontent.com/52ad3672f53d12285d465b90fa219fc2b73d07b09ee755bb8af563d2fa86210c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f66696e646f6c6f6769632f66696e646f6c6f6769632d6170692e737667)](https://packagist.org/packages/findologic/findologic-api) Synopsis -------- [](#synopsis) FINDOLOGIC-API is an object oriented wrapper for the Findologic API, with over 300 automated unit-tests and 100% code coverage. This library not only helps requesting the Findologic API, but also getting data from the response and mapping them to corresponding objects. You won't have to mess around with sending requests and getting the data from the Findologic's response anymore. You want to get filters? Just call `Response::getMainFilters()`. It really is that simple, just try out the [Basic Usage](#basic-usage) or see some [Examples](#examples). To have a better understanding about the API, please make sure to read the general Findologic API documentation. We already got you covered with quicklinks to it: - [Requesting the API](https://docs.findologic.com/doku.php?id=integration_documentation:request) - [Response: XML](https://docs.findologic.com/doku.php?id=integration_documentation:response_xml) | [API spec (non-interactive)](https://github.com/findologic/xml-response-schema/blob/master/schema.xsd) - Response: JSON | [API spec (interactive)](https://service.findologic.com/ps/centralized-frontend/spec/) | [API spec (non-interactive)](https://github.com/findologic/json-response-schema/blob/0.x/resources/schema.json) ### Limitations [](#limitations) Currently, we support the following response formats: Response TypeFormatVersionSupportedEnd of lifeSearch/NavigationJSON1.0✔️Not in the foreseeable futureXML2.1✔️Not in the foreseeable futureXML2.0✖️ → Use XML\_2.1 instead2019-10-18HTMLany✔️ → The response is not parsedNot in the foreseeable futureSmart SuggestJSON3.0✔️Not in the foreseeable futureItem UpdateJSONlatest✔️Not in the foreseeable futureRequirements ------------ [](#requirements) - [PHP](https://php.net/) >= 8.1 - [PHP curl extension](https://www.php.net/manual/en/curl.installation.php) (optional) - [Composer](https://getcomposer.org/) Installation ------------ [](#installation) For a simple installation you can use [Composer](https://getcomposer.org/). Using this command will install the latest version. ``` composer require findologic/findologic-api ``` Basic usage ----------- [](#basic-usage) The usage is pretty simple. Here is an example: ``` // 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 -------- [](#examples) - Working examples can be found in the [`/examples`](https://github.com/findologic/findologic-api/tree/master/examples) directory. - The documentation can be found in our [Project Wiki](https://github.com/findologic/findologic-api/wiki). ### Projects using this library [](#projects-using-this-library) - [FINDOLOGIC Shopware 6 plugin](https://github.com/findologic/plugin-shopware-6) - [FINDOLOGIC Shopware 5 plugin](https://github.com/findologic/plugin-shopware-5) - [Simple Symfony 5 demo](https://github.com/TheKeymaster/findologic-api-demo-symfony) (shows a simple FINDOLOGIC-API integration) - Many more to come... Bug Report ---------- [](#bug-report) We need your help! If you find any bug, please submit an issue and use our template! Be as precise as possible so we can reproduce your case easier. For further information, please refer to our issue template at [.github/ISSUE\_TEMPLATE/bug\_report.md](.github/ISSUE_TEMPLATE/bug_report.md). Contributing ------------ [](#contributing) Please check [our contribution guide](contributing.md) on how to contribute. ### Health Score 37 — LowBetter than 83% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity34 Limited adoption so far Community21 Small or concentrated contributor base Maturity80 Battle-tested with a long release history Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~72 days Recently: every ~246 days Total 23 Last Release 1064d ago Major Versions v0.2.0 → v1.0.0-beta.12019-05-25 v1.8.0 → v2.0.02023-06-19 PHP version history (2 changes)v0.1.0PHP >=5.6 v2.0.0PHP >=8.1 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/20741025?v=4)[Codex Fons](/maintainers/codexfons)[@codexfons](https://github.com/codexfons) ![](https://www.gravatar.com/avatar/6971dc7475dbc578cb9aa4379421f56c493e1e849a6d94bf70b0b8e6194772bb?d=identicon)[g.sorst@findologic.com](/maintainers/g.sorst@findologic.com) ![](https://avatars.githubusercontent.com/u/51320851?v=4)[Tobias Graml](/maintainers/TobiasGraml11)[@TobiasGraml11](https://github.com/TobiasGraml11) --- Top Contributors [![TobiasGraml11](https://avatars.githubusercontent.com/u/51320851?v=4)](https://github.com/TobiasGraml11 "TobiasGraml11 (16 commits)")[![TheKeymaster](https://avatars.githubusercontent.com/u/20555112?v=4)](https://github.com/TheKeymaster "TheKeymaster (11 commits)")[![zaifastafa](https://avatars.githubusercontent.com/u/24492269?v=4)](https://github.com/zaifastafa "zaifastafa (5 commits)")[![georgms](https://avatars.githubusercontent.com/u/2857634?v=4)](https://github.com/georgms "georgms (2 commits)")[![howard](https://avatars.githubusercontent.com/u/26047?v=4)](https://github.com/howard "howard (2 commits)") --- Tags api-clientclientfindologicfindologic-apilibraryphprequestresponse ### Code Quality TestsPHPUnit Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/findologic-findologic-api/health.svg) ``` [![Health](https://phpackages.com/badges/findologic-findologic-api/health.svg)](https://phpackages.com/packages/findologic-findologic-api) ``` ### Alternatives [tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi Kit PHP SDK for the Kit API 2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk Rest Client SDK for hydra API 1125.9k2](/packages/mapado-rest-client-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)