Download the PHP package dystcz/lunar-api-newsletter without Composer
On this page you can find all versions of the php package dystcz/lunar-api-newsletter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dystcz/lunar-api-newsletter
More information about dystcz/lunar-api-newsletter
Files in dystcz/lunar-api-newsletter
Package lunar-api-newsletter
Short Description Add the possibility to sign up to newsletter lists to your Lunar backend
License MIT
Homepage https://github.com/dystcz/lunar-api-newsletter
Informations about the package lunar-api-newsletter
Lunar API Newsletter
This lunar-api compatible package exposes an API endpoint which allows you to subscribe to newsletter lists by providing an email address using the spatie/laravel-newsletter package.
This initial version only takes an email address and subscribes to a list. There may be more endpoints added upon request in the future.
Installation
You can install the package via composer:
To publish the laravel-newsletter config file to config/newsletter.php
run:
The full configuration can be found here: spatie/laravel-newsletter
Using Brevo
To use Brevo, install this extra package.
The driver
key of the newsletter
config file must be set to Dystcz\LunarApiNewsletter\Drivers\BrevoDriver::class
.
Next, you must provide values for the API key and list.subscribers.id
. You'll find these values in Brevo settings.
The endpoint
config value can be set to an empty string.
Using MailChimp
To use MailChimp, install this extra package.
The driver
key of the newsletter
config file must be set to Spatie\Newsletter\Drivers\MailChimpDriver::class
.
Next, you must provide values for the API key and list.subscribers.id
. You'll find these values in the MailChimp UI.
The endpoint
config value can be set to an empty string.
Using Mailcoach
To let this package work with Mailcoach, you need to install the Mailcoach SDK.
Next, you must provide values for the API key, endpoint and list.subscribers.id
in the config file. You'll find the API key and endpoint in the Mailcoach settings screen. The value for list.subscribers.id
must be the UUID of an email list on Mailcoach. You'll find this value on the settings screen of an email list
Usage
Make a POST
request here /api/v1/newsletters/-actions/subscribe
with the following data:
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Jakub Theimer
- Spatie
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of lunar-api-newsletter with dependencies
illuminate/support Version ^11.0
spatie/laravel-newsletter Version ^5.1
dystcz/lunar-api Version ^1.0.0-beta