dystrc / lunar-api-newsletter
将订阅新闻列表的功能添加到您的Lunar后端
Requires
- php: ^8.2
- dystcz/lunar-api: ^1.0.0-alpha
- illuminate/support: ^11.0
- spatie/laravel-newsletter: ^5.1
Requires (Dev)
- drewm/mailchimp-api: ^2.5
- getbrevo/brevo-php: ^1.0
- laravel-json-api/testing: ^3.0
- laravel/pint: ^1.7
- orchestra/testbench: ^9.0
- pestphp/pest: ^2.0
- pestphp/pest-plugin-faker: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- spatie/laravel-ray: ^1.32
- spatie/mailcoach-sdk-php: ^1.1
Suggests
- drewm/mailchimp-api: For working with MailChimp
- getbrevo/brevo-php: For working with Brevo
- spatie/mailcoach-sdk-php: For working with Mailcoach
This package is auto-updated.
Last update: 2024-09-23 15:56:22 UTC
README
此与lunar-api兼容的包公开了一个API端点，允许您通过使用spatie/laravel-newsletter包提供电子邮件地址来订阅新闻列表。
此初始版本仅接受电子邮件地址并订阅列表。未来可能会根据需求添加更多端点。
安装
您可以通过composer安装此包
composer require dystcz/lunar-api-newsletter
要将laravel-newsletter配置文件发布到config/newsletter.php，请运行以下命令
php artisan vendor:publish --tag="newsletter-config"
完整的配置可以在这里找到：spatie/laravel-newsletter
使用Brevo
要使用Brevo，请安装此额外包。
composer require getbrevo/brevo-php "1.x.x"
newsletter配置文件的driver键必须设置为Dystcz\LunarApiNewsletter\Drivers\BrevoDriver::class。
接下来，您必须提供API密钥和list.subscribers.id的值。您可以在Brevo设置中找到这些值。
endpoint配置值可以设置为空字符串。
使用MailChimp
要使用MailChimp，请安装此额外包。
composer require drewm/mailchimp-api
newsletter配置文件的driver键必须设置为Spatie\Newsletter\Drivers\MailChimpDriver::class。
接下来，您必须提供API密钥和list.subscribers.id的值。您可以在MailChimp UI中找到这些值。
endpoint配置值可以设置为空字符串。
使用Mailcoach
要使此包与Mailcoach一起使用，您需要安装Mailcoach SDK。
composer require spatie/mailcoach-sdk-php
接下来，您必须在配置文件中提供API密钥、端点和list.subscribers.id的值。您可以在Mailcoach设置屏幕中找到API密钥和端点。对于list.subscribers.id，必须是Mailcoach上电子邮件列表的UUID。您可以在电子邮件列表的设置屏幕中找到此值
用法
在此处发送以下数据的POST请求/api/v1/newsletters/-actions/subscribe
$data = [ 'type' => 'newsletters', 'attributes' => [ 'email' => $email, ], ];
测试
composer test
变更日志
有关最近更改的更多信息，请参阅CHANGELOG
贡献
有关详细信息，请参阅CONTRIBUTING
安全性
如果您发现任何与安全性相关的问题，请通过电子邮件jakub@dy.st报告，而不是使用问题跟踪器。
鸣谢
许可
MIT许可（MIT）。有关更多信息，请参阅许可文件