https://github.com/findify/php-sdk

Findify PHP SDK
https://github.com/findify/php-sdk

composer findify php php-sdk sdk search

Last synced: about 2 months ago
JSON representation

Findify PHP SDK

• Host: GitHub
• URL: https://github.com/findify/php-sdk
• Owner: findify
• License: mit
• Created: 2017-01-19T07:56:24.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-04-03T14:39:41.000Z (almost 6 years ago)
• Last Synced: 2024-05-02T23:38:22.592Z (9 months ago)
• Topics: composer, findify, php, php-sdk, sdk, search
• Language: PHP
• Size: 81.1 KB
• Stars: 0
• Watchers: 17
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Findify PHP SDK

This is a PHP SDK for our JSON API, you can check full documentation at [Findify Developer Portal](https://developers.findify.io/)

## Requirements

PHP 5.4.0 and later

## Installation & Usage

### Composer

To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:

```

{

  "require": {

    "findify/sdk": "1.*"

  }

}

```

Then run `composer install`

### Manual Installation

Download the files and include `autoload.php`:

```php

require_once('/path-to-findify-sdk/autoload.php');

```

## Getting Started

_Please visit [Findify Developer Portal](https://developers.findify.io) for the full API spec and guides._

### Authentication

Please check [Findify Developer Portal](https://developers.findify.io/reference#authentication) to get the API key

### Requesting the API

Please follow the [installation procedure](#installation--usage) and then run the following:

```php

setApiKey('X-Key', 'YOUR_API_KEY');

$api_instance = new Swagger\Client\Api\DefaultApi();

$autocomplete = new \Swagger\Client\Model\AutocompleteRequest(); // \Swagger\Client\Model\AutocompleteRequest | Request parameters for autocomplete

try {

    $result = $api_instance->autocompletePost($autocomplete);

    print_r($result);

} catch (Exception $e) {

    echo 'Exception when calling DefaultApi->autocompletePost: ', $e->getMessage(), PHP_EOL;

}

?>

```

## Documentation for API Endpoints

All URIs are relative to *https://api-v3.findify.io/v3*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*DefaultApi* | [**autocompletePost**](docs/Api/DefaultApi.md#autocompletepost) | **POST** /autocomplete | 

*DefaultApi* | [**feedbackPost**](docs/Api/DefaultApi.md#feedbackpost) | **POST** /feedback | 

*DefaultApi* | [**recommendItemsFeaturedPost**](docs/Api/DefaultApi.md#recommenditemsfeaturedpost) | **POST** /recommend/items/featured | 

*DefaultApi* | [**recommendItemsItemIdViewedViewedPost**](docs/Api/DefaultApi.md#recommenditemsitemidviewedviewedpost) | **POST** /recommend/items/{item_id}/viewed/viewed | 

*DefaultApi* | [**recommendItemsItemIdsBoughtBoughtPost**](docs/Api/DefaultApi.md#recommenditemsitemidsboughtboughtpost) | **POST** /recommend/items/{item_ids}/bought/bought | 

*DefaultApi* | [**recommendItemsNewestPost**](docs/Api/DefaultApi.md#recommenditemsnewestpost) | **POST** /recommend/items/newest | 

*DefaultApi* | [**recommendItemsTrendingPost**](docs/Api/DefaultApi.md#recommenditemstrendingpost) | **POST** /recommend/items/trending | 

*DefaultApi* | [**recommendItemsViewedLatestPost**](docs/Api/DefaultApi.md#recommenditemsviewedlatestpost) | **POST** /recommend/items/viewed/latest | 

*DefaultApi* | [**recommendSlotPost**](docs/Api/DefaultApi.md#recommendslotpost) | **POST** /recommend/{slot} | 

*DefaultApi* | [**searchPost**](docs/Api/DefaultApi.md#searchpost) | **POST** /search | 

*DefaultApi* | [**smartCollectionSlotPost**](docs/Api/DefaultApi.md#smartcollectionslotpost) | **POST** /smart-collection/{slot} | 

## Documentation For Models

 - [AutocompleteRequest](docs/Model/AutocompleteRequest.md)

 - [AutocompleteResponse](docs/Model/AutocompleteResponse.md)

 - [AutocompleteResponseMeta](docs/Model/AutocompleteResponseMeta.md)

 - [AutocompleteSuggestion](docs/Model/AutocompleteSuggestion.md)

 - [Banner](docs/Model/Banner.md)

 - [BannerProducts](docs/Model/BannerProducts.md)

 - [CollectionRequest](docs/Model/CollectionRequest.md)

 - [CollectionResponse](docs/Model/CollectionResponse.md)

 - [CollectionResponseMeta](docs/Model/CollectionResponseMeta.md)

 - [Error](docs/Model/Error.md)

 - [Facet](docs/Model/Facet.md)

 - [FacetChildValueFour](docs/Model/FacetChildValueFour.md)

 - [FacetChildValueOne](docs/Model/FacetChildValueOne.md)

 - [FacetChildValueThree](docs/Model/FacetChildValueThree.md)

 - [FacetChildValueTwo](docs/Model/FacetChildValueTwo.md)

 - [FeaturedRecommendationRequest](docs/Model/FeaturedRecommendationRequest.md)

 - [Feedback](docs/Model/Feedback.md)

 - [Filter](docs/Model/Filter.md)

 - [FilterValues](docs/Model/FilterValues.md)

 - [GenericRecommendationRequest](docs/Model/GenericRecommendationRequest.md)

 - [GenericRecommendationResponse](docs/Model/GenericRecommendationResponse.md)

 - [GenericRecommendationResponseMeta](docs/Model/GenericRecommendationResponseMeta.md)

 - [Product](docs/Model/Product.md)

 - [RecommendationFilter](docs/Model/RecommendationFilter.md)

 - [RecommendationFilterValues](docs/Model/RecommendationFilterValues.md)

 - [RecommendationRequest](docs/Model/RecommendationRequest.md)

 - [Redirect](docs/Model/Redirect.md)

 - [SearchRequest](docs/Model/SearchRequest.md)

 - [SearchResponse](docs/Model/SearchResponse.md)

 - [SearchResponseMeta](docs/Model/SearchResponseMeta.md)

 - [Sort](docs/Model/Sort.md)

 - [User](docs/Model/User.md)

 

## Running tests

To run the unit tests:

```

composer install

./vendor/bin/phpunit lib/Tests

```

## Contributing

Feel free to create issues, send pull requests or contact us at [email protected]!

## Licence

MIT