Circle APIS 节点.js 库

圆形节点库为圆形API提供方便访问 用服务器侧 JavaScript 编写的应用程序。 API 参考文献 圆形 API 文件。 。 。 .

所需资源

节点10以上.

安装

以 :

npm install @circle-fin/circle-sdk --save
# or
yarn add @circle-fin/circle-sdk

使用量

要拨打API, 您需要 API 密钥 。 一旦获得一个,您可以使用这个SDK使API调用如下:

import { Circle, CircleEnvironments, SubscriptionRequest } from "@circle-fin/circle-sdk";

// Initialize API driver
const circle = new Circle(
    '<your-api-key>',
    CircleEnvironments.sandbox      // API base url
);

async function createSubscription() {
    const subscribeReq: SubscriptionRequest = {
        endpoint: "https://example.org/handler/for/notifications"
    };

    const subscribeResp = await circle.subscriptions.createSubscription(subscribeReq);
    console.log(subscribeResp.data);
}
createSubscription();

发展

使用 Clone 此重播并安装依赖性

yarn install

1. 运行编码源命令,从中生成此 SDK 的源代码 sdk.json OpenAPI 规格文件 :

   yarn gen-sdk
   

2. 运行所有测试 :

   yarn test
   

捐款

请跟随 常规武器委员会 在创建此还本付息请求时, 向所有人输入格式.