README

Simple PHP API to fetch your KiyOh reviews from the JSON feed.

For the previous version of the KiyOh feed please use the 1.0 branch.

Installation

You can install the package via composer:

composer require mvdnbrk/kiyoh-php-api

Getting started

Initialize the KiyOh client and set your API key and company ID:

$client = new \Mvdnbrk\Kiyoh\Client();

$client->setApiKey('your-secret-hash');

Retrieve the KiyOh feed

$feed = $client->feed->get();

By default this will retrieve the 10 most recent reviews. You may change the number of reviews to retrieve by using the limit() method:

$feed = $kiyoh->feed->limit(25)->get();

The migrated reviews from the previous KiyOh platform are not included by default. If you would like to retrieve the migrated reviews as well you may call the withMigrated() method:

$feed = $kiyoh->feed->withMigrated()->get();

Reviews

$feed->reviews->each(function ($review) {
    $review->rating;
    $review->recommendation;
    $review->hasHeadline();
    $review->headline;
    $review->hasText();
    $review->text;
    $review->createdAt;
    $review->updatedAt;

    $review->author->hasName();
    $review->author->name;
    $review->author->hasLocality();
    $review->author->locality;
});

Company properties and statistics

$feed->company->id;
$feed->company->name;
$feed->company->reviewCount;
$feed->company->averageRating;
$feed->company->recommendationPercentage;

Usage with Laravel

Update your .env file by adding your KiyOh sercret hash:

KIYOH_SECRET=YOUR-SECRET-HASH

To create a kiyoh_reviews table in your database run the migrate command:

php artisan migrate

To import your reviews in the database run the kiyoh:import command:

php artisan kiyoh:import

The table name can be changed in the kiyoh.php config file. To publish the config file run:

php artisan vendor:publish --tag=kiyoh-config

To publish the migration file run:

php artisan vendor:publish --tag=kiyoh-migrations

If you are not going to use the default migrations, you should call the Kiyoh::ignoreMigrations() method in the register method of your AppServiceProvider.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

mvdnbrk / kiyoh-php-api

Maintainers

Details