Skip to content
Dominik Brader edited this page Jul 17, 2020 · 9 revisions

Build Status Maintainability codecov Packagist

Introduction

Welcome to Wiki for this repo!

The goal of this library is to create easy-to-use library for anyone who might need one. This fully object oriented library is a wrapper for the FINDOLOGIC API. This means you can easily send requests with a Client which will send your Requests and mapping them to Response objects.

Here are some handy features:

  • Alivetest requests - Are automatically sent for all requests where it is required (Search and Navigation). You no longer need to think about sending alivetests.
  • Parameter handling and validation. We are using Valitron for validating parameter and configuration values.
  • Request objects allow easy setting of query parameters.
  • Response objects allow easy access to response data.
  • And many many more cool features!

Miss a key feature in this list? Feel free to create an issue or a PR if you find anything that is worth improving!

Installation

Requirements

If you have composer installed, you simply can run composer require findologic/findologic-api to get the latest version.

Getting Started

Read about sending and parsing requests in Getting Started.