盲页节点.js SDK
官方节点Js SDK为 盲页 - 全球支付稳定币API.
安装
npm install @blindpay/node
# or
yarn add @blindpay/node
# or
pnpm add @blindpay/node
# or
bun add @blindpay/node
认证
要启动, 您既需要您的 API 密钥, 也需要您的实例 ID, 您可以从 BlindPay 仪表板获取您的 API 密钥和实例 ID https://app.blindpay.com/instances/{instanceId}/api-keys (英语)
import { BlindPay } from '@blindpay/node';
const blindpay = new BlindPay({
apiKey: 'your-api-key-here',
instanceId: 'your-instance-id-here'
})
[注]
所有 api 呼叫将使用提供的 api 密钥和实例 ID
快速启动
检查可用的栏杆
async function getAvailableRails() {
const blindpay = new BlindPay({
apiKey: 'your-api-key-here',
instanceId: 'your-instance-id-here'
});
const { data, error } = await blindpay.available.getRails();
if (error) {
throw new Error(error.message)
}
console.log('Rails: ', data)
}
getAvailableRails()
答复格式
所有API方法返回一致的响应格式
成功对策
{
data: /* your data */ ,
error: null
}
错误反应
{
data: null,
error: {
message: "Error message"
}
}
处理错误
此 SDK 使用一致的错误处理模式 。 总是检查错误 :
const { data, error } = await blindpay.payins.list();
if (error) {
// error.code is a stable code (e.g. PAYOUTS_INSUFFICIENT_BALANCE); error.description is
// safe to show to end users; include error.trace_id when contacting support.
console.error('API Error:', error.code ?? error.message);
return;
}
console.log('Success:', data); // fully typed
安全复试(能力)
创建、更新或删除某种东西的每一种方法都需要一个可选的最后参数。 通过一个 idempotencyKey 并用相同的密钥和相同的输入重试可以重放原始的响应而不是两次行动,例如,超时让您无法确定是否创建了付款。 钥匙保存24小时.
import { randomUUID } from 'node:crypto';
const idempotencyKey = randomUUID(); // reuse it only to retry this same call
const { data, error } = await blindpay.payouts.createEvm(
{ quote_id: 'qu_000000000000', sender_wallet_address: '0x...' },
{ idempotencyKey }
);
网络呼号
constructWebhookEvent 验证Svix的签名并返回其输入的有效载荷 webhook_event它会扔出一个 BlindPayError 当验证失败时。 传出生请求正文,不是重序对象.
const event = blindpay.constructWebhookEvent({
secret: process.env.BLINDPAY_WEBHOOK_SECRET as string,
headers: {
id: req.headers['svix-id'] as string,
timestamp: req.headers['svix-timestamp'] as string,
signature: req.headers['svix-signature'] as string,
},
payload: rawBody,
});
switch (event.webhook_event) {
case 'tos.accept':
console.log('ToS accepted:', event.tos_id);
break;
case 'customer.update':
console.log('KYC status:', event.kyc_status);
break;
}
verifyWebhookSignature 仅需要布尔值时仍然可用.
详细的API文件,访问:
支助
- 电子邮件: [email protected] (英语)
- 问题: GitHub 问题
许可证
这个项目根据麻省理工学院许可证颁发——见 自由主义 详细文件.
由美国制造 盲页 团队