playox / brevo-php
官方Brevo提供的RESTFul API V3 PHP库
dev-main
2024-05-22 13:57 UTC
Requires
- php: >=5.6
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.3.0|^7.4.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-09-22 14:40:37 UTC
README
Brevo的API通过标准化的程序接口公开了所有Brevo功能。请参阅完整的文档以获取更多信息。
这是API的包装器。它实现了API v3的所有功能。
Brevo的API符合OpenAPI v2定义。规范可以在此下载。
此PHP软件包由Swagger Codegen项目自动生成,并由Brevo审查和维护。
- API版本:3.0.0
- 构建软件包:io.swagger.codegen.languages.PhpClientCodegen。有关更多信息,请访问https://account.brevo.com/support
要求
PHP 5.6及更高版本
安装和用法
Composer
要使用Composer安装绑定
在任意目录下创建一个composer.json
文件,并在composer.json文件中添加以下代码。
{
"require": {
"getbrevo/brevo-php": "1.x.x"
}
}
然后在同一目录下运行以下命令
composer require getbrevo/brevo-php "1.x.x"
进一步执行
- 运行
composer install
以将以下依赖项添加到您的vendor目录 - 使用此行将自动加载器添加到您的应用程序:
require("vendor/autoload.php")
测试
要运行单元测试
composer install
./vendor/bin/phpunit
入门指南
请遵循安装过程,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: api-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer'); // Configure API key authorization: partner-key $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKey('partner-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Brevo\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('partner-key', 'Bearer'); $apiInstance = new Brevo\Client\Api\AccountApi( // 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->getAccount(); print_r($result); } catch (Exception $e) { echo 'Exception when calling AccountApi->getAccount: ', $e->getMessage(), PHP_EOL; } ?>
API端点文档
所有URI均相对于https://api.brevo.com/v3
模型文档
- AbTestCampaignResult
- AbTestCampaignResultClickedLinks
- AbTestCampaignResultStatistics
- AbTestVersionClicks
- AbTestVersionClicksInner
- AbTestVersionStats
- AddChildDomain
- AddContactToList
- AddCredits
- AuthenticateDomainModel
- BlockDomain
- Body
- Body1
- Body10
- Body11
- Body12
- Body13
- Body14
- Body2
- Body3
- Body4
- Body5
- Body6
- Body7
- Body8
- Body9
- BodyVariablesItems
- CompaniesList
- Company
- CompanyAttributes
- CompanyAttributesInner
- ComponentItems
- ConversationsMessage
- ConversationsMessageFile
- ConversationsMessageFileImageInfo
- CreateApiKeyRequest
- CreateApiKeyResponse
- CreateAttribute
- CreateAttributeEnumeration
- CreateCategoryModel
- CreateChild
- CreateContact
- CreateCouponCollection
- CreateCoupons
- CreateDoiContact
- CreateDomain
- CreateDomainModel
- CreateDomainModelDnsRecords
- CreateDomainModelDnsRecordsDkimRecord
- CreateEmailCampaign
- CreateEmailCampaignRecipients
- CreateEmailCampaignSender
- CreateExternalFeed
- CreateList
- CreateModel
- CreateProductModel
- CreateReseller
- CreateSender
- CreateSenderIps
- CreateSenderModel
- CreateSmsCampaign
- CreateSmsCampaignRecipients
- CreateSmtpEmail
- CreateSmtpTemplate
- CreateSmtpTemplateSender
- CreateSubAccount
- CreateSubAccountResponse
- CreateUpdateBatchCategory
- CreateUpdateBatchCategoryModel
- CreateUpdateBatchProducts
- CreateUpdateBatchProductsModel
- CreateUpdateCategories
- CreateUpdateCategory
- CreateUpdateContactModel
- CreateUpdateFolder
- CreateUpdateProduct
- CreateUpdateProducts
- 创建Webhook
- 创建WhatsApp营销活动
- 创建WhatsApp营销活动接收者
- 创建WhatsApp模板
- 创建批次ID
- 创建流程ID
- 交易
- 交易属性
- 交易属性内部
- 交易列表
- 删除硬退信
- 邮件导出接收者
- 错误模型
- 导出Webhook历史记录
- 文件数据
- 可下载的文件链接
- 文件列表
- 获取账户
- 获取账户活动
- 获取账户活动日志
- 获取账户营销自动化
- 获取账户计划
- 获取账户中继
- 获取账户中继数据
- 获取聚合报告
- 获取所有外部源
- 获取所有外部源源
- 获取属性
- 获取属性属性
- 获取属性枚举
- 获取被阻止的域名
- 获取营销活动概览
- 获取营销活动接收者
- 获取营销活动统计
- 获取类别
- 获取类别详情
- 获取子账户创建状态
- 获取子域名
- 获取子域名列表
- 获取子账户信息
- 获取子账户API密钥
- 获取子账户API密钥V2
- 获取子账户API密钥V3
- 获取子账户余额
- 获取子账户统计
- 获取子账户列表
- 获取客户
- 获取联系人营销活动统计
- 获取联系人营销活动点击统计
- 获取联系人营销活动打开统计
- 获取联系人营销活动交易属性统计
- 获取联系人营销活动取消订阅统计
- 获取联系人详情
- 获取联系人列表
- 获取公司邀请用户列表
- 获取公司邀请用户列表功能访问
- 获取公司邀请用户列表组
- 获取公司邀请用户列表用户
- 获取优惠券集合
- 获取设备浏览器统计
- 获取域名配置模型
- 获取域名列表
- 获取域名列表域名
- 获取电子邮件营销活动
- 获取电子邮件营销活动列表
- 获取电子邮件事件报告
- 获取电子邮件事件报告事件
- 获取扩展营销活动概览
- 获取扩展营销活动概览发件人
- 获取扩展营销活动统计
- 获取扩展营销活动全局统计
- 获取扩展客户
- 获取扩展客户地址
- 获取扩展联系人详情
- 获取扩展联系人详情统计
- 获取扩展联系人详情点击统计
- 获取扩展联系人详情投递统计
- 获取扩展联系人详情链接统计
- 获取扩展联系人详情消息发送统计
- 获取扩展联系人详情打开统计
- 获取扩展联系人详情取消订阅统计
- 获取扩展联系人详情管理员取消订阅
- 获取扩展联系人详情用户取消订阅
- 获取扩展列表
- 获取扩展列表营销活动统计
- 通过UUID获取外部源
- 获取外部源UUID头信息
- 获取文件夹
- 获取文件夹列表
- 获取文件夹列表
- 获取入站电子邮件事件
- 通过UUID获取入站电子邮件事件
- 通过UUID获取入站电子邮件事件附件
- 通过UUID获取入站电子邮件事件日志
- 获取入站电子邮件事件事件
- 获取邀请用户列表
- 获取邀请用户列表功能访问
- 获取邀请用户列表用户
- 获取IP地址
- 从发件人获取IP地址
- 获取IP地址列表
- 从发件人获取IP地址列表
- 获取列表
- 获取列表列表
- 获取订单
- 获取流程
- 获取流程列表
- 获取产品详情
- 获取产品列表
- 获取报告
- 获取报告列表
- 通过批次ID获取计划发送的电子邮件
- 通过批次ID获取计划发送的电子邮件批次
- 通过消息ID获取计划发送的电子邮件
- 获取分段
- 获取分段列表
- 获取发件人列表
- 获取发件人列表IP
- 获取发件人列表发件人
- 获取共享模板URL
- 获取短信营销活动
- 获取短信营销活动概览
- 获取短信营销活动接收者
- 获取短信营销活动统计
- 获取短信营销活动列表
- 获取短信事件报告
- 获取短信事件报告事件
- 获取SMTP模板概览
- 获取SMTP模板概览发件人
- 获取SMTP模板
- 获取SSO令牌
- 按浏览器获取统计
- 按设备获取统计
- 按域名获取统计
- 获取交易聚合短信报告
- 获取交易被阻止联系人
- 获取交易被阻止联系人联系人
- 获取交易被阻止联系人原因
- 获取交易电子邮件内容
- 获取交易电子邮件内容事件
- 获取交易电子邮件列表
- 获取交易电子邮件列表交易电子邮件
- 获取交易短信报告
- 获取交易短信报告报告
- 获取用户权限
- 获取用户权限特权
- 获取WAT模板
- 获取WAT模板列表
- 获取Webhook
- 获取Webhook认证
- 获取Webhook头信息
- 获取Webhook列表
- 获取WhatsApp配置
- 获取WhatsApp营销活动概览
- 获取WhatsApp营销活动列表
- 获取WhatsApp营销活动列表营销活动
- 获取WhatsApp事件报告
- 获取WhatsApp事件报告事件
- 内联响应200
- 内联响应2001
- 内联响应2002
- 内联响应201
- 内联响应2011
- 内联响应2012
- 内联响应2013
- 行内响应2014
- 行内响应2015
- 邀请管理员用户
- 邀请管理员用户权限
- 邀请用户
- 邀请用户权限
- 管理IP
- 主详细信息响应
- 主详细信息响应计费信息
- 主详细信息响应计费信息地址
- 主详细信息响应计费信息名称
- 主详细信息响应计划信息
- 主详细信息响应计划信息功能
- 备注
- 备注数据
- 备注ID
- 备注列表
- 订单
- 订单批量
- 订单计费
- 订单产品
- OTP
- 管道
- 管道阶段
- 管道列表
- 发布联系信息
- 发布联系信息联系人
- 发布发送失败
- 发布发送短信测试失败
- 撤销用户权限
- 重置发送取消邀请
- 剩余信用模型
- 剩余信用模型子级
- 剩余信用模型分销商
- 从列表中移除联系人
- 移除信用
- 请求联系人导出
- 请求联系人导出自定义联系人筛选器
- 请求联系人导入
- 请求联系人导入JSON正文
- 请求联系人导入新列表
- 请求短信接收者导出
- 安排SMTP电子邮件
- 发送报告
- 发送报告电子邮件
- 发送短信
- 发送SMTP电子邮件
- 发送SMTP电子邮件附件
- 发送SMTP电子邮件BCC
- 发送SMTP电子邮件CC
- 发送SMTP电子邮件消息版本
- 发送SMTP电子邮件回复到
- 发送SMTP电子邮件回复到1
- 发送SMTP电子邮件发件人
- 发送SMTP电子邮件到
- 发送SMTP电子邮件到1
- 发送测试电子邮件
- 发送测试短信
- 发送交易短信
- 发送WhatsApp消息
- SSO令牌请求
- 子账户应用切换请求
- 子账户详细信息响应
- 子账户详细信息响应计划信息
- 子账户详细信息响应计划信息信用
- 子账户详细信息响应计划信息电子邮件
- 子账户详细信息响应计划信息功能
- 子账户详细信息响应计划信息功能收件箱
- 子账户详细信息响应计划信息功能着陆页
- 子账户详细信息响应计划信息功能用户
- 子账户更新计划请求
- 子账户更新计划请求信用
- 子账户更新计划请求功能
- 子账户响应
- 子账户响应子账户
- 任务
- 任务列表
- 任务提醒
- 任务类型
- 更新属性
- 更新属性枚举
- 更新批量联系人
- 更新批量联系人联系人
- 更新批量联系人模型
- 更新活动状态
- 更新子级
- 更新子账户状态
- 更新子域
- 更新联系人
- 更新优惠券集合
- 更新电子邮件活动
- 更新电子邮件活动接收者
- 更新电子邮件活动发件人
- 更新外部源
- 更新列表
- 更新发件人
- 更新短信活动
- 更新SMTP模板
- 更新SMTP模板发件人
- 更新Webhook
- 更新WhatsApp活动
- 上传图片模型
- 将图片上传到相册
- 获取子账户信息
- 获取扩展营销活动概览
- 获取扩展客户
- 获取扩展联系人详情
- 获取扩展列表
- 获取短信营销活动
- 获取账户
- 获取电子邮件营销活动
- 变量项
- WhatsApp活动统计
- WhatsApp活动模板
授权文档
api-key
API密钥应作为api-key
通过请求头传递以进行身份验证。
- 类型:API密钥
- API密钥参数名:api-key
- 位置:HTTP头
partner-key
合作伙伴密钥应作为partner-key
与api-key
配对通过请求头传递,以成功验证合作伙伴(可选)。
- 类型:API密钥
- API密钥参数名:partner-key
- 位置:HTTP头
如果您发现一个错误,请将问题发布在Github上。
始终,如果您需要额外的帮助,请在这里给我们留言这里。