用于Mailerlite API的Python包装器
mailerlite-api-python的Python项目详细描述
Mailerlite api python
用于Mailerlite API v2的Python包装器
| Deployment | |
| Build Status | |
| Metrics | |
| License | |
| Community |
入门
安装
此客户机托管在PyPi，名称为mailerlite api python，要安装它，只需运行
pip install mailerlite-api-python
或安装开发人员版本：
^{pr2}$方法参考
如需完整参考，请访问official MailerLite API reference。在
示例
初始化
首先，从您的Mailerlite帐户（Profile>；Integrations>；Developer API）获取您的\u API_密钥。在
>>>frommailerliteimportMailerLiteApi>>>api=MailerLiteApi('YOUR_API_KEY')
活动
获取所有活动或特定活动
>>>all_campaigns=api.campaigns.all()>>>draft=api.compaings.all(status='draft')
修改活动
>>>one_campaign=all_campaigns[0]>>>html='<h1>Title</h1><p>Content</p><p><small><a href=\"{$unsubscribe}\">Unsubscribe</a></small></p>'>>>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","groups":[2984475,3237221],"type":"regular"}>>>api.campaign.create(data)>>>api.campaign.delete(campaign_id=3971635)
计数活动
>>>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')
创建订户
>>>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)
获取组中的所有订户
^{pr21}$从组中获取一个订户
>>>api.groups.subscriber(group_id=12345,subscriber_id=54321)
从组中删除一个订户
>>>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)
Webhooks
获取webhook列表
>>>api.webhooks.all()
获取一个webhook
>>>api.webhooks.get(webhook_id=123456)
创建/更新/删除一个webhook
^{pr31}$账户
# 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步：运行测试
贡献
我们热爱贡献！在
你发现了一个bug或者其他你想改变的东西-太棒了！Create an issue！在
你已经想出了一个办法来解决它-甚至更好！提交Pull Request！在
从contributing guide开始！在
许可证
三条款BSD许可下的项目，更多信息here
- 项目
标签：
欢迎加入QQ群-->： 979659372
