Gr4vy 类型脚本 SDK
开发者方便且类型安全 类型SDK 格鲁维 API (英语).
内容提要
TypeScript 的官方 Gr4vy SDK 提供了从您的服务器端应用程序中与 Gr4vy API 交互的方便方式. 这个SDK可以使您无缝地整合了Gr4vy强大的支付管弦能力,包括:
- 创建交易:以各种支付方法和服务启动和处理支付.
- 管理买方:安全地储存和管理买方信息.
- 储存支付方法:安全地储存并象征性地说明今后使用的支付方法.
- 处理Webhooks:轻松处理并回应Gr4vy的Webhook事件.
- 更多:访问Gr4vy API支付功能的完整套件.
这个SDK是为了简化开发,减少锅炉板代码,帮助您快速高效地与Gr4vy一起起起跑. 它处理认证,请求签名,并为大多数API端点提供易用的方法.
目录
SDK 安装
SDK可以安装其中之一 无, (中文(简体) ), 小时, (中文(简体) ), 包头 或者说 线条 软件包管理器.
国家预防机制
npm add @gr4vy/sdk
菲律宾
pnpm add @gr4vy/sdk
阿宝
bun add @gr4vy/sdk
雅伦
yarn add @gr4vy/sdk
所需资源
对于支持的 JavaScript 运行时间, 请参考 运行时间.md。 。 。 .
SDK 示例使用法
示例
import fs from "fs";
import { Gr4vy, withToken } from "@gr4vy/sdk";
async function run() {
const gr4vy = new Gr4vy({
server: "sandbox",
id: "example",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
const result = await gr4vy.transactions.list({});
// Handle the result
console.log(result);
}
run();
持有者代号生成
或者,您可以用 SDK 或自己的客户端库创建一个符号.
import { getToken } from "@gr4vy/sdk";
async function run() {
const token = await getToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
});
console.log(token);
}
run();
说明: 这只会创造一个符号一次。 使用
withToken以动态生成一个符号 每个请求.
嵌入式符号生成
或者,您可以创建一个用于嵌入的符号如下 .
import { Gr4vy, getEmbedToken } from "@gr4vy/sdk";
async function run() {
const privateKey = fs.readFileSync("private_key.pem", "utf8")
const gr4vy = new Gr4vy({
server: "sandbox",
id: "example",
bearerAuth: withToken({ privateKey }),
});
const checkoutSession = await gr4vy.checkoutSessions.create()
const token = await getEmbedToken({
privateKey,
checkoutSessionId: checkoutSession.id,
embedParams: {
amount: 1299,
currency: 'USD',
buyerExternalIdentifier: 'user-1234',
}
});
console.log(token);
}
run();
说明: 这只会创造一个符号一次。 使用
withToken以动态生成一个符号 每个请求.
自动附加一个退出会话
对于 Embed ,建议在每次交易中都附加一个检出会话. 这个
getEmbedTokenWithCheckoutSession 帮助者使用您的 SDK 客户端创建退出会话
返回带有结果的嵌入符 checkout_session_id 已经钉住,在一个呼叫.
import fs from "node:fs";
import { Gr4vy, getEmbedTokenWithCheckoutSession, withToken } from "@gr4vy/sdk";
async function run() {
const privateKey = fs.readFileSync("private_key.pem", "utf8")
const gr4vy = new Gr4vy({
server: "sandbox",
id: "example",
bearerAuth: withToken({ privateKey }),
});
const token = await getEmbedTokenWithCheckoutSession({
client: gr4vy,
privateKey,
embedParams: {
amount: 1299,
currency: 'USD',
buyerExternalIdentifier: 'user-1234',
}
});
console.log(token);
}
run();
你可以选择通过一个 checkoutSession 种子会话的正体(例如用推车项)
或元数据)和a merchantAccountId 以覆盖客户端配置的商号.
商务账户 ID 选择
根据使用的密钥,您可能需要明确定义要使用的商号账户ID. 在我们的API,
此使用 X-GR4VY-MERCHANT-ACCOUNT-ID 头曰. 使用SDK时,可以设置 merchantAccountId
每一个请求.
const result = await gr4vy.transactions.list({
merchantAccountId: 'merchant-12345'
})
或者,在初始化SDK时也可以设置商号账户ID.
const gr4vy = new Gr4vy({
server: "sandbox",
id: "example",
merchantAccountId: 'merchant-12345',
bearerAuth: withToken({ privateKey }),
});
Webhooks 验证
SDK提供了一个 verifyWebhook 用于验证Gr4vy收到的webhook请求的方法。 这确保了网钩有效载荷是真实的,没有被篡改.
import { verifyWebhook } from "@gr4vy/sdk";
const payload = 'your-webhook-payload'
const secret = 'your-webhook-secret'
const signatureHeader = 'signatures-from-header'
const timestampHeader = 'timestamp-from-header'
const timestampTolerance = 300 // optional, in seconds (default: 0)
try {
verifyWebhook(
payload,
secret,
signatureHeader,
timestampHeader,
timestampTolerance
)
console.log('Webhook verified successfully!')
} catch (error) {
console.error('Webhook verification failed:', error.message)
}
参数
payload:在webhook请求中收到的原始有效载荷字符串.secret:用来签下"网钩"的秘密. 这在你的Gr4vy仪表板上提供.signatureHeader编号:X-Gr4vy-Signature由 webhook 请求发出的头条 .timestampHeader编号:X-Gr4vy-Timestamp由 webhook 请求发出的头条 .timestampTolerance数字 : (备选) 允许的最大值( 以秒计) 在webhook中当前时间和时间戳之间的相差 。 默认为0(没有宽容).
现有资源和业务
可用方法
会计更新者。 工作
- 创建 - 创建账户更新工作
ApiKey 平板电脑
审计日志
- 列表 - 清单审计记录条目
买家
买取者. 礼品卡
- 列表 - 列出买家的礼品卡
买取者. 支付方法
- 列表 - 列出买方付款方法
买取者. 航运 细节
卡片计划定义
- 列表 - 列表卡方案定义
离职会议
数字钱包
数字钱包. 域数
数字钱包. 会议
- 谷歌游戏 - 创建谷歌付费会话
- 苹果纸 - 创建苹果支付会话
- pazeMobile 会议创造 - 创建帕泽移动会话
- 酱油 - 创建帕泽会话
- 纸币会议审查 - 审查帕泽会议
- paze Mobile 会议完成 - 完成帕泽会议
- 点击ToPay - 创建点击支付会话
礼品卡
礼物卡 活动
- 创建 - 激活礼品卡
礼物卡 余额
- 列表 - 礼品卡余额清单
礼物卡 发放
- 创建 - 发礼物卡
商业账户
商业账户。 三维配置
付款链接
支付方法
支付方法。 网络插件
支付方法。 腾讯网. 密码
- 创建 - 提供网络代号密码图
支付方法。 付费服务套件
备选付款办法
- 列表 - 列出付款选项
支付服务定义
支付服务
- 列表 - 清单支付服务
- 创建 - 配置付款服务
- 起来 - 获得支付服务
- 更新 - 更新已配置的付款服务
- 删除 - 删除配置的付款服务
- 校验 - 核查付款服务证书
- 第二届会议 - 为支付服务定义创建一个会话
付款
退款
- 起来 - 退钱
报告执行
- 列表 - 列出已执行报告
报告
报告。 处决
作用
- 列表 - 列出所有角色
三维情景
交易
交易 行动
- 列表 - 交易流程规则
交易 捕获
交易 活动
- 列表 - 列出交易事项
交易 退款
交易 退款
交易 退还. 全体
- 创建 - 创建批次交易退款
交易 定居点
处理错误
Gr4vyError 是所有 HTTP 错误响应的基础类。 其属性如下:
| 财产 | 类型 | 说明 |
|---|---|---|
error.message | string | 错误消息 |
error.statusCode | number | HTTP 响应状态代码 eg 404 |
error.headers | Headers | HTTP 响应头 |
error.body | string | HTTP 躯体. 如果没有尸体返回, 则可以是空字符串 . |
error.rawResponse | Response | 原始 HTTP 响应 |
error.data$ | 可选的 一些错误可能包含结构化数据. 参见错误类。 。 。 . |
示例
import { Gr4vy, withToken } from "@gr4vy/sdk";
import * as errors from "@gr4vy/sdk/models/errors";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
try {
const result = await gr4vy.accountUpdater.jobs.create({
paymentMethodIds: [
"ef9496d8-53a5-4aad-8ca2-00eb68334389",
"f29e886e-93cc-4714-b4a3-12b7a718e595",
],
});
console.log(result);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.Gr4vyError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.Error400) {
console.log(error.data$.type); // string
console.log(error.data$.code); // string
console.log(error.data$.status); // number
console.log(error.data$.message); // string
console.log(error.data$.details); // ErrorDetail[]
}
}
}
}
run();
错误分类
主错误 :
Gr4vyError: HTTP 错误响应的基础类.Error400: 请求无效. 状态代码400。 。 。 .Error401: 请求未经批准. 状态代码401。 。 。 .Error403: 证书无效或呼叫者没有权限对资源采取行动. 状态代码403。 。 。 .Error404: 未找到资源 。 状态代码404。 。 。 .Error405: 不允许请求方法. 状态代码405。 。 。 .Error409: 找到重复的记录。 状态代码409。 。 。 .Error425:请求太早. 状态代码425。 。 。 .Error429: 提出了太多的请求。 状态代码429。 。 。 .Error500: 服务器遇到错误 。 状态代码500。 。 。 .Error502: 服务器遇到错误 。 状态代码502。 。 。 .Error504: 服务器遇到错误 。 状态代码504。 。 。 .HTTPValidationError: 校验出错. 状态代码422。 。 。 *
少常见错误(6)
网络错误 :
ConnectionError: HTTP 客户端无法向服务器提出请求.RequestTimeoutError: HTTP 请求由于中止信号而超时.RequestAbortedError:HTTP请求被客户端中止.InvalidRequestError: 用于创建请求的任何输入无效.UnexpectedClientError:无法识别或出乎意料的错误.
继承从 Gr4vyError数字 :
ResponseValidationError:从服务器返回的数据和SDK期望的结构之间的类型不匹配. 见error.rawValue原值和error.pretty()用于格式化良好的多行字符串.
* 检查 方法文档 以查看该错误是否适用.
服务器选择
按名称选择服务器
您可以通过将服务器名称传递到 server: keyof typeof ServerList 初始化 SDK 客户端实例时的可选参数 。 然后,选定服务器将作为使用它的操作的默认值. 本表列出与可用服务器相关的名称:
| 名称 | 服务器 | 变量 | 说明 |
|---|---|---|---|
sandbox | https://api.sandbox.{id}.gr4vy.app | id | |
production | https://api.{id}.gr4vy.app | id |
如果选中的服务器有变量, 您可以通过 SDK 构建器中提供的额外参数来覆盖其默认值 :
| 变量 | 参数 | 默认 | 说明 |
|---|---|---|---|
id | id: string | "example" | 您的 Gr4vy 实例的子域 . |
示例
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
const result = await gr4vy.accountUpdater.jobs.create({
paymentMethodIds: [
"ef9496d8-53a5-4aad-8ca2-00eb68334389",
"f29e886e-93cc-4714-b4a3-12b7a718e595",
],
});
console.log(result);
}
run();
覆盖服务器 URL / 客户端
默认服务器也可以通过将 URL 传递到 serverURL: string 初始化 SDK 客户端实例时的可选参数 。 例如:
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
const result = await gr4vy.accountUpdater.jobs.create({
paymentMethodIds: [
"ef9496d8-53a5-4aad-8ca2-00eb68334389",
"f29e886e-93cc-4714-b4a3-12b7a718e595",
],
});
console.log(result);
}
run();
自定义 HTTP 客户端
TypeScript SDK 使用一个 HTTPClient 将本地人包裹起来
获取 API这个
客户端是薄薄的包装 fetch 并且提供连接钩子的能力
围绕可用于修改请求或处理的请求生命周期
错误和反应.
这个 HTTPClient 构造器使用可选 fetcher 参数可以是
用于整合第三方 HTTP 客户端或用于编写测试以嘲弄
hTTP 客户端并输入固定设备.
以下例子说明如何:
- 通过使用 未编辑代理代理代理服务器
- 使用该
"beforeRequest"向请求添加自定义头和超时 - 使用该
"requestError"记录错误的钩头
import { Gr4vy } from "@gr4vy/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@gr4vy/sdk/lib/http";
const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
const httpClient = new HTTPClient({
// 'fetcher' takes a function that has the same signature as native 'fetch'.
fetcher: (input, init) =>
// 'dispatcher' is specific to undici and not part of the standard Fetch API.
fetch(input, { ...init, dispatcher } as RequestInit),
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Gr4vy({ httpClient: httpClient });
认证
常客安全计划
这个SDK在全球支持以下安全计划:
| 名称 | 类型 | 计划 | 环境变量 |
|---|---|---|---|
bearerAuth | 网页 | HTTP 缓冲器 | GR4VY_BEARER_AUTH |
用 API 认证 bearerAuth 初始化 SDK 客户端实例时必须设置参数 。 例如:
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
const result = await gr4vy.accountUpdater.jobs.create({
paymentMethodIds: [
"ef9496d8-53a5-4aad-8ca2-00eb68334389",
"f29e886e-93cc-4714-b4a3-12b7a718e595",
],
});
console.log(result);
}
run();
SDK 安装
SDK可以安装其中之一 无, (中文(简体) ), 小时, (中文(简体) ), 包头 或者说 线条 软件包管理器.
国家预防机制
npm add @gr4vy/sdk
菲律宾
pnpm add @gr4vy/sdk
阿宝
bun add @gr4vy/sdk
雅伦
yarn add @gr4vy/sdk
SDK 示例使用法
示例
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
const result = await gr4vy.accountUpdater.jobs.create({
paymentMethodIds: [
"ef9496d8-53a5-4aad-8ca2-00eb68334389",
"f29e886e-93cc-4714-b4a3-12b7a718e595",
],
});
console.log(result);
}
run();
倾斜
此 SDK 中的一些端点支持 pagination. 要用帕吉恩语,你
使您的 SDK 调用如常, 但返回的响应对象也将是
可使用下列设备消耗的同步可执行性: for await...of
语法.
举个例子说
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
const result = await gr4vy.apiKeyPairs.list();
for await (const page of result) {
console.log(page);
}
}
run();
检索
此 SDK 中的一些端点支持重试. 如果在没有任何配置的情况下使用SDK,则会回落到API提供的默认重试策略. 然而,默认的重试策略可以在一次操作的基础上被推翻,或者在整个SDK中被推翻.
更改单个 API 调用默认重试策略, 只需为调用提供重试 Config 对象 :
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
const result = await gr4vy.accountUpdater.jobs.create(
{
paymentMethodIds: [
"ef9496d8-53a5-4aad-8ca2-00eb68334389",
"f29e886e-93cc-4714-b4a3-12b7a718e595",
],
},
undefined,
{
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
},
);
console.log(result);
}
run();
如果您想要覆盖所有支持重试的操作的默认重试策略, 您可以在 SDK 初始化时提供重试Config :
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";
const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});
async function run() {
const result = await gr4vy.accountUpdater.jobs.create({
paymentMethodIds: [
"ef9496d8-53a5-4aad-8ca2-00eb68334389",
"f29e886e-93cc-4714-b4a3-12b7a718e595",
],
});
console.log(result);
}
run();
内容提要
Gr4vy:Gr4vy API. (中文(简体) ).
目录
独立职能
上述所有方法都作为独立功能提供。 这些 函数是用于在浏览器中运行的应用程序的理想功能,没有服务器 运行时间或应用程序捆绑大小为主的其他环境 关心。 当使用捆绑器构建您的应用程序时, 全部未使用 功能将被从最后的捆绑中排除,或者被树切除.
要了解更多独立函数, 请检查 职能.md。 。 。 .
现有的独立职能
accountUpdaterJobsCreate- 创建账户更新工作apiKeyPairsCreate- 创建 API 密钥对apiKeyPairsDelete- 删除 API 密钥对apiKeyPairsGet- 拿一对API钥匙apiKeyPairsList- 列出所有 API 密钥对apiKeyPairsUpdate- 更新 API 密钥对auditLogsList- 清单审计记录条目buyersCreate- 增加买主buyersDelete- 删除买方buyersGet- 找买家buyersGiftCardsList- 列出买家的礼品卡buyersList- 列出所有买家buyersPaymentMethodsList- 列出买方付款方法buyersShippingDetailsCreate- 增加买方运输详情buyersShippingDetailsDelete- 删除买方的货运细节buyersShippingDetailsGet- 获得买方的运输细节buyersShippingDetailsList- 列出买方的货运详情buyersShippingDetailsUpdate- 更新买方的运输细节buyersUpdate- 更新买方cardSchemeDefinitionsList- 列表卡方案定义checkoutSessionsCreate- 创建退出会话checkoutSessionsDelete- 删除退出会话checkoutSessionsGet- 获取退出会话checkoutSessionsUpdate- 更新退出会话digitalWalletsCreate- 登记数字钱包digitalWalletsDelete- 删除数字钱包digitalWalletsDomainsCreate- 注册数字钱包域名digitalWalletsDomainsDelete- 删除数字钱包域digitalWalletsGet- 拿数字钱包digitalWalletsList- 列出数字钱包digitalWalletsSessionsApplePay- 创建苹果支付会话digitalWalletsSessionsClickToPay- 创建点击支付会话digitalWalletsSessionsGooglePay- 创建谷歌付费会话digitalWalletsSessionsPaze- 创建帕泽会话digitalWalletsSessionsPazeMobileSessionComplete- 完成帕泽会议digitalWalletsSessionsPazeMobileSessionCreate- 创建帕泽移动会话digitalWalletsSessionsPazeMobileSessionReview- 审查帕泽会议digitalWalletsUpdate- 更新数字钱包giftCardsActivationsCreate- 激活礼品卡giftCardsBalancesList- 礼品卡余额清单giftCardsCreate- 创建礼品卡giftCardsDelete- 删除礼品卡giftCardsGet- 拿礼物卡giftCardsIssuancesCreate- 发礼物卡giftCardsList- 名单礼品卡merchantAccountsCreate- 创建一个商号merchantAccountsGet- 买个商户merchantAccountsList- 列出所有商业账户merchantAccountsThreeDsConfigurationCreate- 为商家创建 3DS 配置merchantAccountsThreeDsConfigurationDelete- 删除商家的3DS配置merchantAccountsThreeDsConfigurationList- 列出商家的3DS配置merchantAccountsThreeDsConfigurationUpdate- 编辑 3DS 配置merchantAccountsUpdate- 更新一个商号paymentLinksCreate- 添加支付链接paymentLinksExpire- 付款链接过期paymentLinksGet- 获取支付链接paymentLinksList- 列出所有支付链接paymentMethodsCreate- 创建支付方法paymentMethodsDelete- 删除支付方法paymentMethodsGet- 获得支付方法paymentMethodsList- 列出所有付款方法paymentMethodsNetworkTokensCreate- 提供网络信号paymentMethodsNetworkTokensCryptogramCreate- 提供网络代号密码图paymentMethodsNetworkTokensDelete- 删除网络标志paymentMethodsNetworkTokensList- 列出网络符号paymentMethodsNetworkTokensResume- 恢复网络信号paymentMethodsNetworkTokensSuspend- 暂停网络信号paymentMethodsPaymentServiceTokensCreate- 创建支付服务标志paymentMethodsPaymentServiceTokensDelete- 删除付款服务代号paymentMethodsPaymentServiceTokensList- 列出付款服务标志paymentMethodsUpdate- 更新支付方法paymentOptionsList- 列出付款选项paymentServiceDefinitionsGet- 获得支付服务的定义paymentServiceDefinitionsList- 列出付款服务定义paymentServiceDefinitionsSession- 为支付服务定义创建一个会话paymentServicesCreate- 配置付款服务paymentServicesDelete- 删除配置的付款服务paymentServicesGet- 获得支付服务paymentServicesList- 清单支付服务paymentServicesSession- 为支付服务定义创建一个会话paymentServicesUpdate- 更新已配置的付款服务paymentServicesVerify- 核查付款服务证书payoutsCreate- 创造报酬payoutsGet- 拿到钱payoutsList- 创建清单付款refundsGet- 退钱reportExecutionsList- 列出已执行报告reportsCreate- 增加一个报告reportsExecutionsGet- 得到执行报告reportsExecutionsList- 开列处决报告reportsExecutionsUrl- 为已执行的报告创建 URLreportsGet- 拿个报告reportsList- 列出已配置的报告reportsPut- 更新报告rolesList- 列出所有角色threeDsScenariosCreate- 创建3DS方案threeDsScenariosDelete- 删除3DS方案threeDsScenariosList- 列出3DS方案threeDsScenariosUpdate- 更新3DS方案transactionsActionsList- 交易流程规则transactionsCancel- 取消交易transactionsCapture- 扣押交易transactionsCapturesGet- 获取交易记录transactionsCapturesList- 清单交易抓取transactionsCreate- 创建交易transactionsEventsList- 列出交易事项transactionsGet- 获取交易transactionsIncrementAuthorization- 增加交易授权transactionsList- 清单交易transactionsRefundsAllCreate- 创建批次交易退款transactionsRefundsCreate- 创建交易退款transactionsRefundSettlementsGet- 获得交易退款结算transactionsRefundSettlementsList- 清单交易退款结算transactionsRefundsGet- 得到交易退款transactionsRefundsList- 清单交易退款transactionsSettlementsGet- 获得交易结算transactionsSettlementsList- 清单交易结算transactionsSync- 同步交易transactionsUpdate- 手工更新交易transactionsVoid- 虚拟交易
调试
您可以为 SDK 请求和响应设置 SDK 以发送调试日志 .
你可以通过一个匹配的日志 console'作为 SDK 选项的接口.
[尖叫声] 注意调试日志会揭示一些秘密, 如标题中的 API 令牌, 打印到控制台或文件中的日志信息 。 建议只在本地开发期间使用这一特征,而不能用于生产.
import { Gr4vy } from "@gr4vy/sdk";
const sdk = new Gr4vy({ debugLogger: console });
通过设置环境变量也可以启用默认调试日志 GR4VY_DEBUG 改为 true, (中文(简体) ), 1, (中文(简体) ), yes 或者说 on (大小写不敏感). 任何其它价值都使它失效.
发展
测试
SDK有一个端到端的测试套件,能与E2E相对抗. 地点
页:1 private_key.pem 用于repo 根(或导出)中的测试环境
PRIVATE_KEY),然后:
npm install
npx vitest run
见 试验. md 为全向导——套间布局,并列 和CI 硬化、基于财产的测试、覆盖/端点覆盖报告,以及 如何测试与释放管道的联系.
捐款
虽然我们重视对SDK的开源贡献,但这个库是程序生成的. 随便打开公关或Github问题作为概念的证明,我们会尽力将其纳入未来的发行中!