Berbix集成的sdk
berbix的Python项目详细描述
Berbix Python软件开发包
这个berbix python库提供了与berbix api交互的简单接口。
安装
pip install berbix
用法
构建客户机
import berbix
client = berbix.Client(
client_id='your_client_id_here',
client_secret='your_client_secret_here')
创建事务
var transactionTokens = client.createTransaction({
"customer_uid": "interal_customer_uid", // ID for the user in internal database
"template_key": "your_template_key", // Template key for this transaction
})
从刷新令牌创建令牌
refresh_token = '' # fetched from database
transaction_tokens = Tokens.from_refresh(refresh_token)
获取事务数据
transaction_data = client.fetch_transaction(transaction_tokens)
参考
Client
方法
constructor(options)
支持的选项：
client_id（必需）-可以在Berbix仪表板中找到的客户端ID。client_secret（必需）-可以在您的Berbix仪表板中找到的客户端机密。environment-客户端使用的环境默认为:production。http_client-默认http客户端的可选重写。
create_transaction(options): Tokens
在berbix中创建事务以初始化客户端sdk。通常在创建 在事务中，您需要将刷新令牌存储在与 当前活动的用户会话。
支持的选项：
email-用户以前验证过的电子邮件地址。phone-用户以前验证过的电话号码。customer_uid-系统中用户的ID或标识符。template_key-此事务的模板密钥。
fetch_transaction(tokens: Tokens): object
获取与事务关联的所有信息。如果用户已经完成了事务的步骤，那么这将包括Berbix developer docs中描述的事务负载的所有元素。
refresh_tokens(tokens: Tokens): void
这通常不需要显式调用，因为它将由更高级别调用 sdk方法，但可以用于获取新的客户端或访问令牌。
Tokens
属性
access_token: string
这是后端sdk用于标识与给定事务相关联的请求的短期承载令牌。在使用更高级别的sdk方法时，通常不需要这样做。
client_token: string
这是前端sdk用于标识与给定事务相关联的请求的短期令牌。事务创建后，通常会将其发送到前端sdk。
refresh_token: string
这是一个长期令牌，允许您在短期令牌过期后创建新令牌。这通常存储在与给定用户会话关联的数据库中。
transaction_id: number
与事务关联的内部BERBIX ID号。
expiry: Date
访问令牌和客户端令牌将过期的时间。
静态方法
from_refresh(refreshToken: string): Tokens
from_refresh(refreshToken: string): Tokens从刷新令牌创建令牌对象，该对象可以传递给更高级别的sdk方法。sdk将处理刷新令牌以访问相关数据。
发布
To release a new version of the SDK, first bump the version in `setup.py`.
python setup.py sdist bdist_wheel
twine upload dist/*
欢迎加入QQ群-->： 979659372
