https://github.com/vansteen/laravel-sendinblue
A Laravel 5/6/7 service provider, facade and config file for the SendinBlue's API v3 official PHP library.
https://github.com/vansteen/laravel-sendinblue
laravel sendinblue
Last synced: about 3 hours ago
JSON representation
A Laravel 5/6/7 service provider, facade and config file for the SendinBlue's API v3 official PHP library.
- Host: GitHub
- URL: https://github.com/vansteen/laravel-sendinblue
- Owner: vansteen
- License: mit
- Created: 2018-05-25T14:16:00.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-26T12:44:39.000Z (over 1 year ago)
- Last Synced: 2025-04-20T17:42:25.700Z (6 days ago)
- Topics: laravel, sendinblue
- Language: PHP
- Homepage:
- Size: 31.3 KB
- Stars: 18
- Watchers: 1
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license.md
Awesome Lists containing this project
README
# Laravel Sendinblue
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-downloads]
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-coverage]][link-coverage]
[![Quality Score][ico-code-quality]][link-code-quality]
[![StyleCI][ico-styleci]][link-styleci]
[![License][ico-license]][link-license]
The package simply provides a Laravel service provider, facade and config file for the SendinBlue's API v3 official PHP library.
## Installation
You can install this package via Composer using:
```bash
composer require vansteen/laravel-sendinblue
```
For Laravel <5.5, you must also install the service provider and the facade to your `config/app.php`:
```php
// config/app.php
'providers' => [
...
Vansteen\Sendinblue\SendinblueServiceProvider::class,
...
];
```
```php
// config/app.php
'aliases' => [
...
'Sendinblue' => Vansteen\Sendinblue\Facades\Sendinblue::class,
];
```
## Configuration
You need to publish the config file to `app/config/sendinblue.php`. To do so, run:
```bash
php artisan vendor:publish --tag=sendinblue.config
```
Now you need to set your configuration using **environment variables**.
Go the the Sendinblue API settings and add the v3 API key to your `.env` file.
```bash
SENDINBLUE_APIKEY=xkeysib-XXXXXXXXXXXXXXXXXXX
```
## Usage
To test it, you can add the folowing code in routes.php.
```php
// routes.php
...
use Vansteen\Sendinblue\Facades\Sendinblue;
Route::get('/test', function () {
// Configure API keys authorization according to the config file
$config = Sendinblue::getConfiguration();
// Uncomment below to setup prefix (e.g. Bearer) for API keys, if needed
// $config->setApiKeyPrefix('api-key', 'Bearer');
// $config->setApiKeyPrefix('partner-key', 'Bearer');
$apiInstance = new \SendinBlue\Client\Api\ListsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getLists();
dd($result);
} catch (Exception $e) {
echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL;
}
});
```
To get a idea of the of the API endpoints, visit the API [readme file](https://github.com/sendinblue/APIv3-php-library#documentation-for-api-endpoints).
Be sure to visit the SendinBlue official [documentation website](https://sendinblue.readme.io/docs) for additional information about our API.
## Change log
Please see the [changelog](changelog.md) for more information on what has changed recently.
## Testing
```bash
composer test
```
## Contributing
Please see [contributing.md](contributing.md) for details and a todolist.
## Security
If you discover any security related issues, please email author email instead of using the issue tracker.
## License
license. Please see the [license file](license.md) for more information.
[ico-version]: https://poser.pugx.org/vansteen/laravel-sendinblue/v/stable
[ico-downloads]: https://poser.pugx.org/vansteen/laravel-sendinblue/downloads
[ico-travis]: https://travis-ci.org/vansteen/laravel-sendinblue.svg?branch=master
[ico-coverage]: https://coveralls.io/repos/github/vansteen/laravel-sendinblue/badge.svg?branch=master
[ico-code-quality]: https://scrutinizer-ci.com/g/vansteen/laravel-sendinblue/badges/quality-score.png?b=master
[ico-styleci]: https://github.styleci.io/repos/134865450/shield?style=flat
[ico-license]: https://poser.pugx.org/vansteen/laravel-sendinblue/license
[link-packagist]: https://packagist.org/packages/vansteen/laravel-sendinblue
[link-downloads]: https://packagist.org/packages/vansteen/laravel-sendinblue
[link-travis]: https://travis-ci.org/vansteen/laravel-sendinblue
[link-code-quality]: https://scrutinizer-ci.com/g/vansteen/laravel-sendinblue
[link-styleci]: https://styleci.io/repos/134865450
[link-coverage]: https://coveralls.io/github/vansteen/laravel-sendinblue?branch=master
[link-license]: https://github.com/vansteen/laravel-sendinblue/blob/HEAD/license.md