一种低配置服务,用于发送基于条带Webhook的通知和接收。
stripe-hooks的Python项目详细描述
条纹挂钩
这是一个python web应用程序,用于接收webhooks 从条纹和发送电子邮件相应。
这是Jack Pearkes原作的一个分支: stripe-hooks。
有两种类型的电子邮件:
- Notifications,发送给管理员
- Receipts,发送给客户
用例:
- 发送有关重要条带事件的通知,例如失败 向管理员收取费用或新客户
- 收取费用后将收据发送给用户
它支持all条带events。
默认情况下,包含的电子邮件内容是通用英语。任何 它可以修改以适合您的业务或用例。很容易 部署,您不需要触摸python来配置它。
安装
$ python3 setup.py install
配置
所有配置都是用json完成的。
在^{.json
文件,并将其放到命令行:
$ stripe-hooks configuration.json
更多详情如下:
电子邮件类型
默认情况下,所有收据和通知都是关,空白configuration.json
。
若要激活通知或收据,只需创建一个新密钥,名为 事件类型(可以找到列表here) 格式如下:
{..."email":{"charge.failed":{"active":true,"subject":"Oh nos! A Charge Has Failed!"}}...}
subject
是可选的。默认情况下,电子邮件主题将是,
句点替换空格和标题,前缀为
业务名称(如果存在)类似于:^ {< CD5> }。
一切都会回到安全、通用的默认值,比如不显示企业名称 如果它不存在。
电子邮件类型配置可能如下:
{..."email":{"business":{"name":"Acme, Inc.","signoff":"The Acme Team","email":"Acme Support Team <support@example.com>"},"notifications":{"balance.available":{"active":true,"subject":"Dat chedda is available..."},"charge.succeeded":{"active":true},"charge.failed":{"active":true},"charge.refunded":{"active":true}},"receipts":{"invoice.created":{"active":true,"subject":"New Invoice"}}}...}
电子邮件内容
您需要提供电子邮件模板的路径:
{..."email":{"templates_path":"stripe-hooks-emails",...}...}
你可以用叉子叉that repository,你会有一个好的开始。
条纹
您需要在stripe guistripe webhooks中配置条带webhook。
服务默认端口是5000
,路由url是/webhook
。
当您拥有端点密码时,只需将其放入配置文件:
{..."stripe":{"endpoint_secret":"whsec_..."},...}
端点机密将用于对stripe documentation之后的条带POST
请求进行身份验证。
电子邮件提供商
SMTP用作与电子邮件提供商的默认接口。
将其添加到配置文件中:
{..."smtp":{"url":"localhost:25"},...}
Mailgun是一个很好的供应商。条纹团队在那里使用自己的文档。
如果您想使用amazon ses,请还原commitrefactor(mail): use a smtp server instead of aws ses
。
测试
在制品
贡献
只需删除一个git karma样式的pr。
当单元测试是最新的时,它们将需要通过。
project暂时不符合Flake8lint,因此它不是强制的,但可能很酷。