NPM Package
在 npmjs.com 查看该包
安装
使用你偏好的包管理器安装:快速开始
开始使用前,需要先用你的 API Key 初始化客户端。你可以在 Clink Dashboard 的 Developers 页面找到密钥。uiMode 设置为 elements,并提供 returnUrl,例如 https://YOUR_DOMAIN/complete.html?session_id={ELEMENTS_SESSION_ID}。Clink 会将 {ELEMENTS_SESSION_ID} 替换为创建出的 session ID。
如果你用的是 @clink-ai/clink-js 的嵌入式 iframe,则改用 uiMode: 'hostedPage'——那个 SDK 原样挂载托管结账页。
API 概览
createCheckoutSession(options):创建 checkout session,并返回跳转urlgetCheckoutSession(sessionId):查询 checkout session 详情getOrder(orderId):查询订单详情getRefund(refundId):查询退款详情getSubscription(subscriptionId):查询订阅详情getInvoice(invoiceId):查询订阅发票详情customerPortalSession(options):创建 customer portal session,并返回访问链接
错误处理
当 API 返回非成功状态码(4xx 或 5xx)时,SDK 会抛出错误。建议用try/catch 包裹调用逻辑。
验证 Webhook 签名
ClinkWebhook 会帮你算并比对 HMAC,不用自己写。
verifySignature() 返回布尔值而不抛异常,signature() 用来生成签名——本地造测试事件时用得上。