有效负载python库
payload-api的Python项目详细描述
有效负载python库
用于集成Payload的python库。
安装
使用PIP安装
pip install payload-api
开始
一旦您将payload python库安装到您的环境中,
导入payload
模块以开始。注意:我们建议
导入时使用pl
的速记名称。
importpayloadaspl
API认证
要使用有效负载api进行身份验证,您需要一个活动的或测试的api密钥。应用程序接口 可以从有效负载仪表板中访问钥匙。
importpayloadasplpl.api_key='secret_key_3bW9JMZtPVDOfFNzwRdfE'
创建对象
与payload api的接口主要通过payload对象完成。下面是一个例子
使用pl.Customer
对象创建客户。
# Create a Customercustomer=pl.Customer.create(email='matt.perez@example.com',full_name='Matt Perez')
# Create a Paymentpayment=pl.Payment.create(amount=100.0,payment_method=pl.Card(card_number='4242 4242 4242 4242'))
访问对象属性
对象属性可以通过点表示法访问。
customer.name
更新对象
更新对象是对update
对象方法的简单调用。
# Updating a customer's emailcustomer.update(email='matt.perez@newwork.com')
选择对象
可以使用对象的任何属性来选择对象。
# Select a customer by emailcustomers=pl.Customer.filter_by(email='matt.perez@example.com')
使用pl.attr
属性助手
接口编写功能强大的查询,并添加一些额外的语法糖。
payments=pl.Payments.filter_by(pl.attr.amount>100,pl.attr.amount<200,pl.attr.description.contains("Test"),pl.attr.created_at>datetime(2019,2,1))).all()
文档
为了进一步了解payload的python库和api功能, 访问未桥接的Payload Documentation。