跳转到主要内容

​
集成概览

Waffo Pancake 提供强大的 API 和开发者工具，将支付直接集成到您的应用中。

​
API 架构

Waffo Pancake 使用混合 API：
  • REST (POST) 用于所有写操作，路径为 /v1/actions/{domain}/{action}
  • GraphQL 用于所有读操作，路径为 /v1/graphql
Your Application
    |
    +-- REST POST requests --> Create/Update/Delete
    |
    +-- GraphQL queries --> Read data

​
基础 URL

https://waffo-pancake-auth-service.vercel.app/v1

​
API Keys

API Key 用于认证服务端请求。认证由 SDK 自动处理。

测试密钥

为 test 环境创建。不产生真实扣款。

正式密钥

为 prod 环境创建。处理真实支付。

​
创建 API Key

1

前往开发者页面

前往仪表盘 > 开发者。
2

生成密钥对

点击”生成”创建密钥对。公钥将发送到服务器。
3

命名密钥

为密钥取一个描述性名称（如”Production Server”）。
4

选择环境

选择测试或正式环境。密钥与环境绑定。
5

下载私钥

下载并安全存储您的私钥。私钥只会显示一次。

​
API Key 端点

端点说明
POST /v1/actions/api-key/create-key创建新的 API Key
POST /v1/actions/api-key/delete-key删除现有的 API Key
切勿在客户端代码、版本控制或公开仓库中暴露您的私钥。

​
Webhooks

Webhooks 在事件发生时实时通知您的服务器。

​
设置步骤

1

前往 Webhooks 设置

前往仪表盘 > 设置 > Webhooks。
2

输入 Webhook URL

为每个环境配置单独的 Webhook URL：
  • 测试 Webhook URL — 接收测试模式的事件
  • 正式 Webhook URL — 接收正式模式的事件
3

保存配置

保存设置。您的端点将开始接收所有 Webhook 事件。
没有事件过滤功能——您的 Webhook 端点会接收所有事件。请在服务端处理程序中按事件类型进行过滤。

​
验证 Webhook 签名

Webhooks 设置页面会显示一个 Webhook 公钥。使用此密钥验证传入的 Webhook 负载确实由 Waffo Pancake 发送且未被篡改。

​
常用端点

​
商店

端点说明
POST /v1/actions/store/create-store创建商店
POST /v1/actions/store/update-store更新商店信息
POST /v1/actions/store/delete-store软删除商店

​
产品

端点说明
POST /v1/actions/onetime-product/create-product创建一次性产品
POST /v1/actions/onetime-product/update-product更新一次性产品（创建新版本）
POST /v1/actions/onetime-product/update-status激活或停用一次性产品
POST /v1/actions/onetime-product/publish-product跨环境发布一次性产品
POST /v1/actions/subscription-product/create-product创建订阅产品
POST /v1/actions/subscription-product/update-product更新订阅产品
POST /v1/actions/subscription-product/update-status激活或停用订阅产品
POST /v1/actions/subscription-product/publish-product跨环境发布订阅产品

​
订单

端点说明
POST /v1/actions/onetime-order/create-order创建一次性结账会话
POST /v1/actions/onetime-order/cancel-order取消待处理的一次性订单
POST /v1/actions/subscription-order/create-order创建订阅结账会话
POST /v1/actions/subscription-order/cancel-order取消订阅
POST /v1/actions/subscription-order/change-product升级或降级订阅产品

​
退款

端点说明
POST /v1/actions/refund-ticket/create-ticket申请退款

​
数据查询

端点说明
POST /v1/graphql查询任意数据（商店、产品、订单、支付等）

​
安全最佳实践

环境变量

将私钥存储在环境变量中，切勿写在代码里。

密钥轮换

定期轮换密钥，尤其是团队成员变动后。

环境分离

为测试和正式环境使用不同的 API Key。

安全存储

使用您平台的密钥管理服务存储私钥。

​
后续步骤

集成概览

分步集成指南。

API 参考

完整的端点文档。