README

一个用于与Brevo PHP SDK无缝集成的Laravel扩展包，允许在您的Laravel应用程序中访问Brevo强大的电子邮件、短信和营销自动化服务。此扩展包通过提供干净且易于使用的接口简化了Brevo API的使用。

特性

• 简单的Brevo API集成：访问Brevo的电子邮件营销、短信、交易电子邮件和营销自动化API。
• 全面的API支持：包括对Brevo的联系人、活动、电子邮件、短信、Webhooks等多种API的支持。
• Laravel Facade：使用Brevo外观与Brevo API无缝交互。
• 自定义配置：通过配置文件自定义API密钥和其他设置。

安装

步骤 1：使用Composer安装

您可以通过Composer安装此扩展包

composer require sarfrazrizwan/laravel-brevo

步骤 2：发布配置

将扩展包配置文件发布到您的应用程序

php artisan vendor:publish --provider="RizwanSarfraz\LaravelBrevo\BrevoServiceProvider" --tag="config"

这将创建一个config/brevo.php文件，您可以在其中设置您的Brevo API密钥。

步骤 3：设置API密钥

在您的.env文件中添加您的Brevo API密钥

BREVO_API_KEY=your-brevo-api-key

使用方法

外观

Brevo外观允许您这样访问Brevo API

use RizwanSarfraz\LaravelBrevo\Facades\Brevo;

// Access Account API
$accountApi = Brevo::accountApi();
$account = $accountApi->getAccount();

// Access Contacts API
$contactsApi = Brevo::contactsApi();
$contacts = $contactsApi->getContacts();

可用的API

以下是通过此扩展包可以访问的一些API

• accountApi()
• attributesApi()
• companiesApi()
• contactsApi()
• conversationsApi()
• couponsApi()
• crmApi()
• dealsApi()
• domainsApi()
• ecommerceApi()
• emailCampaignsApi()
• externalFeedsApi()
• filesApi()
• foldersApi()
• inboundParsingApi()
• listsApi()
• masterAccountApi()
• notesApi()
• processApi()
• resellerApi()
• sendersApi()
• smsCampaignsApi()
• tasksApi()
• transactionalEmailsApi()
• transactionalSmsApi()
• transactionalWhatsAppApi()
• userApi()
• webhooksApi()
• whatsAppCampaignsApi()

异常处理

如果API密钥缺失或无效，扩展包将抛出ApiKeyIsMissing异常。请确保您的.env文件包含正确的BREVO_API_KEY。

测试

运行扩展包测试

vendor/bin/phpunit

贡献

欢迎贡献！请提交拉取请求或创建问题来讨论任何更改或改进。

许可

此扩展包是开源软件，根据MIT许可授权。

关键词

• Laravel Brevo集成
• Brevo PHP SDK
• Laravel营销自动化
• Laravel电子邮件营销API
• Laravel短信营销
• Laravel交易电子邮件
• Brevo API集成
• Laravel扩展包 Brevo