README

一个简单的PHP API，用于从JSON源获取您的KiyOh评论。

对于KiyOh源的旧版本，请使用1.0分支。

安装

您可以通过composer安装此包

composer require mvdnbrk/kiyoh-php-api

入门指南

初始化KiyOh客户端并设置您的API密钥和公司ID

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

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

获取KiyOh源

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

默认情况下，这将检索最新的10条评论。您可以通过使用limit()方法更改要检索的评论数量

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

默认情况下不包括从旧KiyOh平台迁移的评论。如果您想同时检索迁移的评论，可以调用withMigrated()方法

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

$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;
});

公司属性和统计信息

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

Laravel中使用

更新您的.env文件，添加您的KiyOh密钥散列

KIYOH_SECRET=YOUR-SECRET-HASH

要在数据库中创建kiyoh_reviews表，运行migrate命令

php artisan migrate

要导入评论到数据库，运行kiyoh:import命令

php artisan kiyoh:import

可以在kiyoh.php配置文件中更改表名。要发布配置文件，请运行

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

要发布迁移文件，请运行

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

如果您不打算使用默认迁移，应该在AppServiceProvider的register方法中调用Kiyoh::ignoreMigrations()方法。

测试

composer test

更新日志

请参阅更新日志以获取有关最近更改的更多信息。

贡献

请参阅贡献指南以获取详细信息。

安全漏洞

请查看我们的安全策略了解如何报告安全漏洞。

鸣谢

许可协议

MIT许可（MIT）。请参阅许可文件以获取更多信息。

mvdnbrk / kiyoh-php-api

维护者

详细信息