#api #api-client #com #paid #api-key #building #get402

get402-rust

使用Get402.com构建付费API的客户端Rust

1个不稳定版本

0.0.1 2022年2月17日

#4#paid

自定义许可证

4KB

Get402客户端Rust

轻松构建付费API。这个库简化了只能通过小额支付访问的API的提供

安装

cargo install get402

使用

您可以导入整个库,也可以根据需要加载特定对象



身份验证

您的Get402 API由一对公钥/私钥标识,其中公钥地址用于标识您的API,私钥用于对get402.com的请求进行签名。

使用现有的API私钥



生成新的API私钥



一旦您使用私钥加载了您的应用程序,就不再需要做任何事情,所有请求的签名都由库自动处理。

获取客户端API密钥余额

所有客户端开始时都有零余额可用,这可以在任何时候查询

创建新的客户端



获取现有客户端的余额



向客户端API密钥收费

当客户端使用您的API时,您应该向他们的API密钥收费,这将减少他们可用的信用余额。



如果他们的信用余额降至零,您将收到一个错误,包括一个带有购买额外信用详细信息的PaymentRequired请求。如果您不想收到错误,请始终先检查余额。



向客户端API密钥充钱

获取购买更多信用的支付请求

要购买额外的信用,只需请求任何数量的新支付模板。您将收到一个标准的支付请求,钱包知道如何完成。



使用客户端密钥直接购买更多信用

由于客户端API密钥实际上是具有直接持有资金的公钥/私钥对,因此这个库提供了一种使用客户端私钥直接购买新信用的实用程序。首先,您必须通过向客户端标识符地址发送satoshis来加载您的客户端资金。一旦资金到达,它们就可以用于购买信用。



一旦付款发送,您的客户端API密钥将立即获得额外的信用

开发

cargo build

要运行测试,您必须在shell或.文件中设置GET402_PRIVATE_KEY环境变量

cargo test

无运行时依赖