findify/sdk

PHP SDK for Findify API

Findify PHP SDK

This is a PHP SDK for our JSON API, you can check full documentation at Findify Developer Portal, _(*1)

Requirements

PHP 5.4.0 and later, _(*2)

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:, _(*3)

{
  "require": {
    "findify/sdk": "1.*"
  }
}

Then run composer install, _(*4)

Manual Installation

Download the files and include autoload.php:, _(*5)

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

Getting Started

Please visit Findify Developer Portal for the full API spec and guides., _(*6)

Authentication

Please check Findify Developer Portal to get the API key, _(*7)

Requesting the API

Please follow the installation procedure and then run the following:, _(*8)

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, _(*9)

Documentation For Models

• AutocompleteRequest
• AutocompleteResponse
• AutocompleteResponseMeta
• AutocompleteSuggestion
• Banner
• BannerProducts
• CollectionRequest
• CollectionResponse
• CollectionResponseMeta
• Error
• Facet
• FacetChildValueFour
• FacetChildValueOne
• FacetChildValueThree
• FacetChildValueTwo
• FeaturedRecommendationRequest
• Feedback
• Filter
• FilterValues
• GenericRecommendationRequest
• GenericRecommendationResponse
• GenericRecommendationResponseMeta
• Product
• RecommendationFilter
• RecommendationFilterValues
• RecommendationRequest
• Redirect
• SearchRequest
• SearchResponse
• SearchResponseMeta
• Sort
• User

Running tests

To run the unit tests:, _(*10)

composer install
./vendor/bin/phpunit lib/Tests

Contributing

Feel free to create issues, send pull requests or contact us at yourfriends@findify.io!, _(*11)

Licence

MIT, _(*12)