Skip to main content

SDKs 和库

Waffo Pancake 提供 TypeScript 和 Next.js 官方 SDK,以及直接 API 访问。

选择你的集成方式

Next.js SDK

最快 — 开箱即用的组件、Hooks 和 Server Actions。内置收银台 UI、Webhook 路由和买家自助服务。npm install @waffo/pancake-nextjs

TypeScript SDK

灵活 — 完整 API 覆盖,自动签名、类型化响应和 Webhook 验证。适用于任何 Node.js 框架。npm install @waffo/pancake-ts

直接 API

完全控制 — REST 端点用于写操作,GraphQL 用于读操作。自行实现签名和验证。任何语言。
Next.js 项目:从 @waffo/pancake-nextjs 开始 — 它封装了 @waffo/pancake-ts 并添加了 React 组件和 Server Actions。如需高级用例,可随时降级到 TypeScript SDK 或原始 API。

TypeScript SDK

@waffo/pancake-ts

npm 上的官方 TypeScript SDK

安装

特性

  • 零运行时依赖,ESM + CJS,Node >= 20
  • 自动请求签名和确定性幂等键
  • 完整的 TypeScript 类型定义(15 个枚举,40+ 接口)
  • 内置公钥的 Webhook 签名验证(测试/生产)

快速开始

配置

可用资源

收银台模式

SDK 支持两种收银台模式,取决于你是否知道买家身份:
当你知道买家身份时,请务必使用认证式收银台。 认证式收银台将订单绑定到你提供的 buyerIdentity — 一个稳定的、商户控制的标识符。没有它:
  • 试用滥用:买家可以通过更换邮箱地址无限领取免费试用
  • 订单断链:不同邮箱被视为不同用户
  • 无自助服务:买家无法在客户门户中管理订单

认证式收银台(推荐)

buyerIdentity 仅用于订单归属和试用追踪,不会渲染到收银台页面。如需预填收银台邮箱输入框,请显式传 buyerEmail
支持动态定价和试用控制:

匿名收银台

Webhook 验证

错误处理


Next.js SDK

@waffo/pancake-nextjs

官方 Next.js SDK — 组件、Hooks 和 Server Actions

安装

需要 @waffo/pancake-ts 作为 peer dependency。适用于 Next.js 14+ App Router。

Client 导出

Server 导出(@waffo/pancake-nextjs/server

快速示例

Webhook Route Handler

Next.js 指南

完整的 Next.js 集成分步指南。

直接 API 访问

你也可以直接使用 REST 和 GraphQL API。API Key 认证由 SDK 自动处理,无需手动设置请求头。

SDK 路线图


框架指南

Next.js

使用 Next.js 和 Server Actions 构建。

收银台会话

通过编程方式创建收银台流程。

订阅

实现周期性计费。

Webhooks

接收实时事件通知。

API 参考

完整的端点文档:

API 参考

完整的 REST 和 GraphQL API 文档。