PHPackages                             capeandbay/birdeye - 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. capeandbay/birdeye

ActiveLibrary

capeandbay/birdeye
==================

Client-side SDK Package for Laravel that integrates with the BirdEye REST API

0.1.3(5y ago)11.5k1MITPHP

Since Sep 30Pushed 5y ago1 watchersCompare

[ Source](https://github.com/capeandbay-devs/birdeye)[ Packagist](https://packagist.org/packages/capeandbay/birdeye)[ Docs](https://github.com/capeandbay/birdeye)[ RSS](/packages/capeandbay-birdeye/feed)WikiDiscussions master Synced yesterday

READMEChangelog (4)Dependencies (7)Versions (4)Used By (0)

[![](https://camo.githubusercontent.com/52c8e15c6af47f931b94239c3a0cdc0b39a35ddb8c56bf0cc69d38384ab1811d/68747470733a2f2f63646e322e626972646579652e636f6d2f76657273696f6e322f636f6e7461696e6572732f6865616465722f677265792d626c75652d6c6f676f2e737667)](https://camo.githubusercontent.com/52c8e15c6af47f931b94239c3a0cdc0b39a35ddb8c56bf0cc69d38384ab1811d/68747470733a2f2f63646e322e626972646579652e636f6d2f76657273696f6e322f636f6e7461696e6572732f6865616465722f677265792d626c75652d6c6f676f2e737667)

BirdEye Service SDK for Laravel
===============================

[](#birdeye-service-sdk-for-laravel)

BirdEye helps your business be found and chosen by new customers, be connected with your existing customers, and deliver the best end-to-end customer experience.

This is an implementation of the BirdEye REST API designed to be used with Laravel PHP Framework v6, 7 and beyond.

Cape & Bay is not affiliated with BirdEye. We prefer to build custom packages for our needs, but it may also help you or be a good reference for your own implementation.

Getting Started
---------------

[](#getting-started)

### Quick Links

[](#quick-links)

1. [Installation](#Installation)
    - [Configuration](#Configuration)
2. [Seed the Database](#migrate-the-child-business-data)
3. [Using the Trait](#using-the-trait)
4. [Usage](#Usage)
    - [Check In](#check-an-enduser-customer-into-a-business)
5. [Change Log](#change-log)
6. [Contributing](#contributing)
7. [Security](#security)
8. [License](#License)

### Installation

[](#installation)

Via Composer

```
$ composer require capeandbay/birdeye
```

The package will automatically register itself. You can optionally publish the config file with:

```
php artisan vendor:publish --provider="CapeAndBay\BirdEye\CBBirdEyeServiceProvider" --tag="config"
```

The settings can be found in the generated `config/birdeye.php` configuration file. .

You can publish the migration with:

```
php artisan vendor:publish --provider="CapeAndBay\BirdEye\CBBirdEyeServiceProvider" --tag="migrations"
```

If you need to, update the config, before running the migration. After publishing the migration you can create the `birdeye_businesses` table by running the migrations:

```
php artisan migrate
```

### Configuration

[](#configuration)

By default, the package uses the following environment variables to auto-configure the plugin without modification:

```
BIRDEYE_API_KEY (default = '')
BIRDEYE_PARENT_BUSINESS_KEY (default = '')
BIRDEYE_API_URL (default = 'https://api.birdeye.com/resources') Can be set to their Mock & Debug URLs as per their API
DB_CONNECTION (default = mysql)

```

```