Mailerlite API的Python包装器
项目描述
Mailerlite-api-python
Mailerlite API v2的Python包装器
| 部署 |  |
| 构建状态 |   |
| 度量 |
 
|
| 许可证 |  |
| 社区 |    |
入门
安装
此客户端托管在PyPi上，名称为mailerlite-api-python，要安装它，只需运行
pip install mailerlite-api-python
或安装开发版本
git clone https://github.com/skoudoro/mailerlite-api-python.git
pip install -e .
方法参考
有关完整参考，请访问官方MailerLite API参考。
示例
初始化
首先，从您的Mailerlite账户（个人资料>集成>开发者API）获取YOUR_API_KEY。
>>> from mailerlite import MailerLiteApi
>>> api = MailerLiteApi('YOUR_API_KEY')
第二个选项是定义一个名为MAILERLITE_PYTHON_API_KEY的环境变量。然后，您不需要在代码中精确指定它
>>> from mailerlite import MailerLiteApi
>>> api = MailerLiteApi()
活动
获取所有活动或特定活动
>>> all_campaigns = api.campaigns.all()
>>> draft = api.compaings.all(status='draft')
修改活动
>>> one_campaign = all_campaigns[0]
>>> html = '<head></head><body><h1>Title</h1><p>Content</p><p><small><a href=\"{$unsubscribe}\">Unsubscribe</a></small></p></body>'
>>> plain = "Your email client does not support HTML emails. "
>>> plain += "Open newsletter here: {$url}. If you do not want"
>>> plain += " to receive emails from us, click here: {$unsubscribe}"
>>> api.campaigns.update(one_campaign.id, html=html, plain=plain)
创建/删除活动
>>> data = {"subject": "Regular campaign subject",
"name": "Regular campaign name",
"groups": [2984475, 3237221],
"type": "regular"}
>>> api.campaign.create(data)
>>> api.campaign.delete(campaign_id=3971635)
发送活动
>>> data = {"subject": "Regular campaign subject",
"name": "Regular campaign name",
"groups": [2984475, 3237221],
"type": "regular"}
>>>
>>> _, res = api.campaign.create(data)
>>> campaign_id = res['id']
>>>
>>> html = '<head></head><body><h1>Your Title</h1><p>Your Content</p><p><small>'
>>> html += '<a href=\"{$unsubscribe}\">Unsubscribe</a></small></p></body>'
>>> plain = "Your email client does not support HTML emails. "
>>> plain += "Open newsletter here: {$url}. If you do not want"
>>> plain += " to receive emails from us, click here: {$unsubscribe}"
>>>
>>> api.campaign.update(campaign_id, html=html, plain=plain)
>>> api.campaign.send(campaign_id)
取消计划中的活动
>>> outbox_campaigns = campaign_obj.all(status='outbox', limit=5)
>>> selected_campaign = outbox_campaigns[0]
>>>
>>> api.campaign.cancel(selected_campaign.id)
活动计数
>>> api.campaign.count()
>>> api.campaign.count(status='draft')
订阅者
获取所有订阅者
>>> api.subscribers.all()
>>> api.subscribers.all(stype='active')
>>> api.subscribers.active()
>>> api.subscribers.unsubscribed()
>>> api.subscribers.bounced()
>>> api.subscribers.junk()
>>> api.subscribers.unconfirmed()
获取一个订阅者
>>> api.subscribers.get(email='demo@mailerlite.com')
>>> api.subscribers.get(id=1343965485)
搜索
>>> api.subscribers.search(search='demo@mailerlite.com')
订阅者组
>>> api.subscribers.groups(id=1343965485)
订阅者活动
>>> api.subscribers.activity(id='1343965485')
>>> api.subscribers.activity(id='1343965485', limit=50, offset=1, atype='clicks')
创建订阅者
>>> data = {'name': 'John',
'email': 'demo-678@mailerlite.com',
'fields': {'company': 'MailerLite'}
}
>>> api.subscribers.create(data)
更新订阅者
>>> data = {'name': 'John',
'fields': {'company': 'MailerLite'}
}
>>> api.subscribers.update(data, id='1343965485')
订阅者计数
在一次调用中获取所有订阅者的总数。
请注意，这不是官方API中记录的功能。
>>> api.subscribers.count()
组
获取所有组
>>> api.groups.all()
>>> api.groups.all(limit=50)
>>> api.groups.all(offset=10)
>>> api.groups.all(gfilters='My Group')
>>> api.groups.all(group_id=12345)
创建组
>>> api.groups.create(group_id=12345, name='My New Group')
重命名组
>>> api.groups.update(group_id=12345, name='New Name')
获取组
>>> api.groups.get(group_id=12345)
删除组
>>> api.groups.delete()
>>> api.groups.delete(group_id=12345)
获取组中的所有订阅者
>>> api.groups.subscribers(group_id=12345)
>>> api.groups.subscribers(group_id=12345, limit=50, offset=1)
>>> api.groups.subscribers(group_id=12345, stype='active')
从组中获取一个订阅者
>>> api.groups.subscriber(group_id=12345, subscriber_id=54321)
将订阅者列表添加到组中
此方法调用导入端点 https://developers.mailerlite.com/reference#add-many-subscribers
>>> api.groups.add_subscribers(group_id=12345, subscribers_data=[{"email": "john@wick.com", "name": "John Wick"}], autoresponders=False, resubscribe=False, as_json=False)
subscriber_data 参数接受一个字典列表或仅包含订阅者姓名和电子邮件的一个字典
将单个订阅者添加到组
此方法调用添加单个订阅者端点 https://developers.mailerlite.com/reference#add-single-subscriber
>>> api.groups.add_single_subscriber(group_id=12345, subscribers_data={"email": "john@wick.com", "name": "John Wick" ...}, autoresponders=False, resubscribe=False, as_json=False)
与上面的方法不同，此方法仅向一个组添加一个订阅者。 subscriber_data 参数接受所有订阅者属性。检查可用的属性 https://developers.mailerlite.com/reference#create-a-subscriber
从组中删除一个订阅者
>>> api.groups.delete_subscriber(group_id=12345, subscriber_id=54321)
段
获取段列表
>>> api.segments.all()
获取段数量
>>> api.segments.count()
字段
获取字段列表
>>> api.fields.all()
获取一个字段
>>> api.fields.get(field_id=123456)
创建/更新/删除一个字段
>>> api.fields.create(title="my custom title")
>>> api.fields.update(field_id=123456, title="my new title 2")
>>> api.fields.delete(field_id=123456)
网络钩子
获取网络钩子列表
>>> api.webhooks.all()
获取一个网络钩子
>>> api.webhooks.get(webhook_id=123456)
创建/更新/删除一个网络钩子
>>> api.webhooks.create(url="https://yoursite/script-is-here",
... event="subscriber.create")
>>> api.webhooks.update(webhook_id=123456,
... url="https://yoursite/script-is-here",
... event="subscriber.create")
>>> api.webhooks.delete(webhook_id=123456)
账户
# Get some info or stats
>>> api.account.info()
>>> api.account.stats()
>>> api.account.double_optin()
# Set up the double_optin
>>> api.account.set_double_optin(True)
批量操作
>>> batch_requests = {"requests": [{"method":"GET",
... "path": "/api/v2/groups"
... },
... {"method":"POST",
... "path": "/api/v2/groups",
... "body": {"name": "New group"}
... }
... ]
... }
>>> api.batch(batch_requests)
测试
- 步骤 1: 安装 pytest
pip install pytest
- 步骤 2: 运行测试
pytest -svv mailerlite
贡献
我们欢迎贡献！
你发现了一个错误或想要更改的其他内容 - 太好了！ 创建一个问题！
你已经找到了解决问题的方法 - 甚至更好！提交一个 Pull Request！
从 贡献指南 开始！
许可证
该项目采用 3-clause BSD 许可证，更多信息 这里
下载文件
下载您平台的文件。如果您不确定选择哪个，请了解更多关于 安装软件包 的信息。
源分布
mailerlite-api-python-0.10.0.tar.gz (44.6 kB 查看散列)
