PHPackages marshmallow/reviews-kiyoh - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. marshmallow/reviews-kiyoh ActiveLibrary[Utility & Helpers](/categories/utility) marshmallow/reviews-kiyoh ========================= Connect your Kiyoh to your Laravel application v1.2.3(2y ago)07.2k↓56.3%[1 PRs](https://github.com/marshmallow-packages/reviews-kiyoh/pulls)MITPHPPHP ^7.4|^8.0CI passing Since May 20Pushed 2w ago1 watchersCompare [ Source](https://github.com/marshmallow-packages/reviews-kiyoh)[ Packagist](https://packagist.org/packages/marshmallow/reviews-kiyoh)[ Docs](https://github.com/Marshmallow-Development/)[ RSS](/packages/marshmallow-reviews-kiyoh/feed)WikiDiscussions main Synced 2d ago READMEChangelog (2)Dependencies (1)Versions (17)Used By (0) [![marshmallow-transparent-logo](https://camo.githubusercontent.com/329958cb02b7bee461fd9dcae7a0a3a34e6595669116ff441ad5ef9e77bc511c/68747470733a2f2f63646e2e6d617273686d616c6c6f772d6f66666963652e636f6d2f6d656469612f696d616765732f6c6f676f2f6d617273686d616c6c6f772e7472616e73706172656e742e7265642e706e67)](https://marshmallow.dev) Laravel Kiyoh Reviews ===================== [](#laravel-kiyoh-reviews) [![Latest Version on Packagist](https://camo.githubusercontent.com/205b89184d34f77ebef764014fa006a7d78c187dddd23bd630e68c5f42991e64/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d617273686d616c6c6f772f726576696577732d6b69796f682e737667)](https://packagist.org/packages/marshmallow/reviews-kiyoh)[![Total Downloads](https://camo.githubusercontent.com/37da19bfa4114599f66aacf05d25e3877aa6fe13cd0200dbe507b25dc67ffd6d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d617273686d616c6c6f772f726576696577732d6b69796f682e737667)](https://packagist.org/packages/marshmallow/reviews-kiyoh)[![License](https://camo.githubusercontent.com/7724d52d6f707c45679fc6dd198db36f3538b6d6c502467fd0b5c1cb7484100f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6d617273686d616c6c6f772f726576696577732d6b69796f682e737667)](https://github.com/marshmallow-packages/reviews-kiyoh/blob/main/LICENSE.md) Connect your [Kiyoh](https://www.kiyoh.com/) account to your Laravel application. Send review invitations, pull your aggregated feed (average score, review count, recommendation), and optionally store reviews in your own database. Installation ------------ [](#installation) You can install this package using composer. ``` composer require marshmallow/reviews-kiyoh ``` The service provider is auto-discovered. The `Kiyoh`, `KiyohInvite` and `KiyohProduct` facades are registered automatically. Setup ----- [](#setup) To start using Kiyoh you need to publish the config and update it accordingly. At a minimum you need to add `hash`, `location_id` and `feed_hash` to `config/kiyoh.php` (or set the matching environment variables). ``` php artisan vendor:publish --provider="Marshmallow\Reviews\Kiyoh\ServiceProvider" ``` ### Configuration [](#configuration) All keys live in `config/kiyoh.php`. The most common values can be set through environment variables: Config keyEnv variableDefaultDescription`hash``KIYOH_INVITE_HASH``null`Hash used to authenticate review invitations.`location_id``KIYOH_LOCATION_ID``null`Your Kiyoh location id.`language``KIYOH_LANGUAGE``nl`Language used for invitations.`delay``KIYOH_INVITE_DELAY_IN_DAYS``3`Default delay (in days) before an invitation is sent.`feed_hash``KIYOH_FEED_HASH``null`Hash used to read the public review feed.`cache_feed_in_seconds``KIYOH_FEED_CACHE_TTL``3600`How long the feed is cached, in seconds.`cache_name``KIYOH_FEED_CACHE_NAME``kiyoh_reviews_object`Cache key under which the feed is stored.`publication_api_token``KIYOH_PUBLICATION_API_TOKEN``null`API token used for product publication endpoints.`models.product`—`Marshmallow\Reviews\Kiyoh\Models\KiyohProduct`Model used to represent a Kiyoh product.The `invite_path`, `review_path`, `product_path` and `product_review_path` keys hold the Kiyoh API endpoints and normally do not need to be changed. Invites ------- [](#invites) ``` use Marshmallow\Reviews\Kiyoh\Facades\KiyohInvite; use Marshmallow\Reviews\Kiyoh\Exceptions\KiyohException; try { KiyohInvite::email('stef@marshmallow.dev') /** * Optional */ ->supplier('Marshmallow') ->firstName('Stef') ->lastName('van Esch') ->refCode('Order: #1001') ->city('Alphen aan den Rijn') ->delayIgnoreWeekend(3) /** * Always end with invite() */ ->invite(); } catch (KiyohException $e) { /** * You should always try-catch this. Kiyoh can * throw an error if someone has already received * an invitation. If this is thrown, you don't want * your code to be killed! */ } ``` Feed aggregate information -------------------------- [](#feed-aggregate-information) Using feed information is very easy. Use the `Kiyoh` facade to access feed data. Available methods are listed below. Please note that by default the XML feed of Kiyoh will be cached using your default `CACHE_DRIVER`. The feed will be cached for 1 hour. You can change this in `config/kiyoh.php`. If for some reason the feed is unavailable an exception will be thrown. If you are using these methods in blade you can prefix the methods with `dontFail()`. If you use `dontFail()` all methods will return `0`. ``` use Marshmallow\Reviews\Kiyoh\Facades\Kiyoh; Kiyoh::feed()->average() Kiyoh::dontFail()->feed()->average(); ``` ### Available methods [](#available-methods) - Kiyoh::feed()->average() - Kiyoh::feed()->count() - Kiyoh::feed()->average12months() - Kiyoh::feed()->count12months() - Kiyoh::feed()->recommendation() - Kiyoh::feed()->getAttribute('average') Store the reviews in your own database -------------------------------------- [](#store-the-reviews-in-your-own-database) If you wish to get all the reviews and store them in your own database or do whatever with it, you can get them with the methods below: ``` $reviews = Kiyoh::withoutCache()->feed(); foreach ($reviews as $review) { // Do your own magic here } ``` The package also ships an artisan command that loads the uncached feed for you, ready to be extended with your own persistence logic: ``` php artisan kiyoh:store-reviews-in-database ``` Products -------- [](#products) ``` php artisan marshmallow:resource KiyohProduct Reviews\\Kiyoh ``` Tests during development ------------------------ [](#tests-during-development) ``` php artisan test packages/marshmallow/reviews/kiyoh ``` Credits ------- [](#credits) - [Stef van Esch](https://github.com/marshmallow-packages) - [All Contributors](https://github.com/marshmallow-packages/reviews-kiyoh/contributors) Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. License ------- [](#license) The MIT License (MIT). Please see the [License File](LICENSE.md) for more information. --- Copyright (c) 2020 marshmallow. ### Health Score 45 — FairBetter than 91% of packages Maintenance63 Regular maintenance activity Popularity22 Limited adoption so far Community10 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 78.8% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~125 days Recently: every ~185 days Total 12 Last Release 859d ago PHP version history (2 changes)v1.0.0PHP ^7.4 v1.0.4PHP ^7.4|^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/be33d2624e24c516e73892b0929447cc762f3622c024ab8d0d2a59042e5d2c7f?d=identicon)[marshmallow](/maintainers/marshmallow) --- Top Contributors [![stefvanesch](https://avatars.githubusercontent.com/u/46725619?v=4)](https://github.com/stefvanesch "stefvanesch (41 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (7 commits)")[![lucienversendaal](https://avatars.githubusercontent.com/u/76224741?v=4)](https://github.com/lucienversendaal "lucienversendaal (4 commits)") --- Tags laravelmarshmallowkiyohlaravel kiyoh ### Embed Badge ![Health badge](/badges/marshmallow-reviews-kiyoh/health.svg) ``` [![Health](https://phpackages.com/badges/marshmallow-reviews-kiyoh/health.svg)](https://phpackages.com/packages/marshmallow-reviews-kiyoh) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)