搜索newsletter2go / api
Newsletter2Go REST API的PHP API实现（https://docs.newsletter2go.com/）
Requires
- php: >=5.3.0
- ext-curl: *
README
newsletter2go-api-php
此PHP库旨在用作我们公开API服务的门面。通过此实现，您可以执行官方API文档网站中包含的几乎所有常见操作。
其他信息
- API版本：1.4
- 此库遵循我们的Postman集合文件结构。
- 您可以通过提交任何请求、错误或问题，或通过implementation@newsletter2go.com联系我们。
要求
- PHP 5.6 及以上
安装和使用
Composer
要使用Composer从命令行安装，只需运行
composer require newsletter2go/api
composer install
仓库
您还可以从该仓库下载独立类并将其添加到您的PHP项目中。
实现
- 此示例展示了如何设置账户凭据并执行进一步的API调用。
<?php
namespace NL2GO;
//Import the standalone class in your working directory
require_once '/Newsletter2Go_REST_Api.php';
//Add your account credentials
$authKey = "your auth key here";
$userEmail = "login email address";
$userPassword = "login password";
//Instantiate the Newsletter2Go_REST_Api
$api = new Newsletter2Go_REST_Api($authKey, $userEmail, $userPassword);
//Allow SSL check
$api->setSSLVerification(true);
//Retrieve and display all the contact lists stored your account
$lists = $api->getLists();
var_dump($lists);
以下是该库支持的实体
列表
getListDetails() - API文档 获取特定列表的所有信息。
createList() - API文档 创建新的列表。
deleteList() - API文档 根据ID删除特定列表
请注意！您将不可撤销地删除整个列表及其所有活动和联系人。
联系人
getRecipients() - API文档 从任何列表中获取收件人。
getRecipient() - API文档 获取特定收件人的详细信息。
updateRecipientList() - API文档 创建一个或多个收件人。如果电子邮件地址已存在，现有收件人将被更新。
deleteRecipientsFromList() - API文档 从特定列表中获取收件人。
updateRecipients() - API文档 更新一个列表中的多个/所有收件人。
确保传递
$filter变量，否则列表中的所有收件人都会被更新。例如：/{{list_id}}/recipients?_filter=email%3DLIKE%3D%22%example%25%22
updateRecipient() - API 文档 通过传递 $recipientId 仅更新一个收件人。
分段
createDynamicSegment() - API 文档 属性 $filter 应该是自动更新操作的条件。属性 $is_dynamic 定义了该段是否会自动更新。
getRecipientSegment() - API 文档 获取指定段中的所有收件人。
addRecipientSegment() - API 文档 将一个收件人添加到段中。
deleteRecipientsSegment() - API 文档 从段中删除一个或多个收件人。
如果不传递
$filter，则所有收件人将被永久从组中删除。
属性
getAttributesList() - API 文档 从列表中检索属性。
getAttributeDetails() - API 文档 从属性获取元数据。
createAttributeList() - API 文档 在给定列表上创建一个新的自定义属性。
活动
createMailing() - API 文档 如果您的列表为 header_from_email、header_from_name、header_reply_email 和/或 header_reply_name 提供默认值，则在没有在此调用中传递它们的情况下将使用这些值。
sendTest() - API 文档 这将发送测试邮件，但不会更改邮件状态。请注意，主题行将前置 [TEST]。
sendOneTimeMailing() - API 文档 有不同的方式来处理邮件。
- 使用
list_id向整个联系人列表发送。 - 向单个段（使用
group_ids字段）发送。 - 仅向单个收件人发送（通过使用
recipient_ids与list_selected字段设置为 false）和 - 上述的组合。
重要：请注意，如果您只想向单个收件人或与细分市场一起发送，则需要将 list_selected 字段设置为 false。这清楚地表明新闻通讯不会发送给整个联系名单。
sendTransactional() - API 文档 您还可以在 recipient 对象中传递其他数据字段（如 first_name 或自定义属性），并在电子邮件正文中引用它们。
updateMailing() - API 文档 如果您想要能够触发自动邮件发送，请确保状态设置为 active。使用 list_selected: true 向整个列表发送，通过在 group_ids 中传递组 ID 数组，或者通过传递包含在 recipient_ids 参数中的数组向单个联系人发送。
getSpecificMailingReports() - API 文档 对于每天运行的自动邮件发送，此调用很有用，因为它按天返回报告。
表单
公司
getCompany() - API 文档 获取您的公司详细信息。