1 个稳定版本
1.0.0 | 2023 年 8 月 31 日 |
---|
#6 在 #v2
27KB
411 行
culqi-rust
使用方法
将此内容放入你的 Cargo.toml
[dependencies]
culqi = "0.2.1"
并在你的包根目录下
extern crate culqi;
生成文档说明
cargo rustdoc --lib
Culqi-Rust
我们的官方 Rust 库,兼容 Culqi API v2.0,通过几个简单的配置步骤,你可以使用它进行信用卡和借记卡、Yape、PagoEfectivo、移动钱包和Cuotéalo 的支付。
我们的库允许你捕获 Culqi API HTTP 请求的 status_code
,以及包含响应体的 response
。
当前版本 | Culqi API |
---|---|
1.0.0 (15-08-2023) | v2 API 参考 |
要求
- Rust 1.6.2+
请记住,要获取密钥,您必须进入 CulqiPanel > 开发 > API 密钥。
请记住,凭据将通过您在注册过程中使用的电子邮件发送。
- 为了加密有效负载,您必须通过进入 CulqiPanel > 开发 > RSA Keys 来生成 RSA id 和密钥。
安装
通过 "go get"
执行以下命令
go get github.com/culqi/culqi-go
go get "github.com/google/uuid"
手动
克隆仓库或下载源代码。
$ git clone [email protected]:culqi/culqi-go.git
快速开始
导入 culqi-go
import (
culqi "github.com/culqi/culqi-go"
)
配置
为了开始向 Culqi API 发送请求,您需要配置您的公钥(pk)、私钥(sk)。要启用有效负载加密,您需要配置您的 rsa_id 和 rsa_public_key。
func main() {
// 1. llaves
culqi.Key("pk_test_xxx", "sk_test_xxx")
encryptiondData = []byte(`{
"rsa_public_key": "` + rsa_public_key + `",
"rsa_id": "` + rsa_id + `"
}`)
}
加密有效负载
为了加密有效负载,您需要创建一个 RSA id 和 RSA 密钥,为此,您必须进入您的面板并点击左侧导航栏中的“开发 / RSA 密钥”部分。
然后,在您的后端中声明 rsa_id 和 rsa 密钥的变量,并在库的函数中发送它们。
示例
rsa_public_key := "la llave pública RSA";
rsa_id := "el id de tu llave"
_, res, err := culqi.CreateToken(jsonData, encryptiondData...)
服务
创建一个令牌
在创建“Cargo”或“Card”之前,需要先创建一个卡token。建议使用Culqi Checkout v4或Culqi JS v4来生成tokens,因为确保信用卡/借记卡数据直接从客户的设备发送到Culqi的服务器是非常重要的,这样可以避免泄露敏感的信用卡/借记卡数据。
请记住,当您直接与API Token交互时,需要遵守PCI DSS 3.2标准。因此,我们要求您填写SAQ-D表格并发送到Culqi的风险邮箱。
statusCode, res, err := culqi.CreateToken(jsonData)
创建付款
创建付款意味着向信用卡收取销售额。为此,您需要先生成一个token并在参数中发送source_id。
可以通过API付款创建付款。
statusCode, res, err := culqi.CreateCharge(json)
创建退款
您可以通过API和CulqiPanel免费请求客户的购买退款(部分或全部)。
可以通过API退款创建退款。
statusCode, res, err := culqi.CreateRefund(json)
创建客户(customer)
客户是一项服务,允许您保存客户信息。这是生成卡片的必要步骤。
可以通过客户API创建客户。
statusCode, res, err := culqi.CreateCustomer(json)
创建卡片(card)
卡片是一项服务,允许您保存客户的信用卡或借记卡信息,以便之后进行一键或定期(后续付款无需客户再次输入卡信息)付款。
可以通过卡片API创建卡片。
statusCode, res, err := culqi.CreateCard(json)
创建计划
计划是一项服务,允许您定义希望多久向客户收取一次费用。
计划定义了订阅的行为。可以通过计划API或从CulqiPanel创建计划。
statusCode, res, err := culqi.CreatePlan(jsonDataPlan)
创建订阅(suscription)
订阅是一项服务,将客户的卡与商家设置的特定计划相关联。
可以通过订阅API创建订阅。
statusCode, res, err := culqi.CreateSubscription(jsonData)
创建订单
这是一项服务,允许您为潜在购买生成付款订单。订单包含销售所需的所有信息,并由PagoEfectivo系统用于执行分期付款。
可以通过订单API创建订单。
statusCode, res, err := culqi.CreateOrder(jsonData)
测试
$ go test -v ./test/ -public_key=pk_test_xxx -secret_key=sk_test_xxx
文档
变更日志
本库所有版本的更改都在变更日志中列出。
作者
Culqi团队
许可证
culqi-python的源代码根据MIT许可证分发,请参阅LICENSE文件。
依赖项
~26–41MB
~727K SLoC