- 速率限制
- 每分钟 300 次请求
- Webhook 签名
- HMAC-SHA256
- 重试
- 从 1 分钟到 12 小时
- 幂等性
- 创建类操作支持
开发者
PapelShip 的设计思路是：在控制台里能做的几乎所有事，通过 API 也能做到。 同步商品、创建付款页、处理订单、管理许可证，并实时监听事件。统一的响应格式、精细的权限和可靠的 Webhook 投递，让您的集成从第一天起就可用于生产环境。
创建账单
REST
请求
POST · 创建
Idempotency-Key: 7d1f0c2a-…
响应
账单已创建
X-Request-Id: req_4c1e9a…
速率限制本分钟已用 13 / 300
Webhook 投递
HMAC-SHA256
- 200已送达
订单事件
已签名 · 第 1 次尝试
- 200已送达
库存事件
已签名 · 第 1 次尝试
- 5031 分钟后重试
评价事件
已签名 · 第 1 次尝试
- 200已送达
提现事件
已签名 · 第 1 次尝试
1 分钟…12 小时重试窗口
功能
为生产环境而生的 API。 精细的访问控制、可预期的行为与可靠的投递
完善的 REST API
涵盖商品、规格、库存、序列号、文件、分类、账单、订单、配送与退款、客户、优惠券、营销活动、订阅、工单、评价、问答、联盟推广和 Webhook。创建账单、退款、取消、PDF 以及重新发送交付等操作，同样可通过 API 完成。
安全可控的访问
API 密钥可按资源设置读写权限，也可设为只读，并支持设置有效期和 IP 白名单。每个密钥的调用次数和错误次数都清晰可查。
为生产环境打造
统一的响应格式，每个请求都带有追踪 ID（
X-Request-Id），创建类操作支持Idempotency-Key。速率上限为每分钟 300 次请求，并附有清晰的速率限制响应头。带签名的 Webhook
实时接收订单、商品、库存、评价、验证、客户、提现和联盟推广事件。每个请求都使用 HMAC-SHA256 签名；投递失败时，系统会按递增间隔自动重试，间隔从 1 分钟直至 12 小时。提供投递日志、手动重发和测试发送，还可将 Webhook 直接路由到 Discord 频道。
浏览器 SDK 与嵌入式结账
通过
window.PapelShipSDK，在您自己的界面中管理购物车、商品和结账，并以页面或嵌入窗口的形式打开结账。Payments API
托管支付链接、含地址、金额和二维码的加密货币支付账单、付款状态查询与退款，并提供 OpenAPI 规范和独立的签名 Webhook。
许可证 API
查询 qPapel 许可证、重置硬件锁定、冻结、封禁和增加时长。另有独立的分销商 API 供您的分销商使用。
面向 AI 智能体的 MCP
通过 OAuth 安全连接 Claude、Cursor 和 VS Code 等 AI 工具，让它们修改您的主题代码。修改会保存为草稿，发布权始终在您手中。
现成插件
提供 WooCommerce、XenForo、WHMCS、Magento 等平台的支付插件。
运作方式
三步即可上手
- 01
创建 API 密钥
选择它所需的权限。
- 02
添加 Webhook 端点
发送一个测试事件。
- 03
将您的集成上线
继续探索
产品、文档与指南。 接下来去哪里
- 文档快速入门完成接入设置，发出第一个请求。
- 文档身份验证API 密钥，以及请求的授权方式。
- 文档Store API 参考商品、订单、客户，以及店铺的其余数据。
- 文档Webhook接收店铺事件并验证其签名。
- 文档qPapel API 参考在您自己的系统中管理许可证。
- 文档面向 AI 工具的 MCP将 AI 编程工具连接到您的主题代码。
- 指南How to add a checkout widget to your website: embedded checkout for card, crypto and bank transferAdd a checkout widget to your website with one script tag. How embedded checkout works, how to set it up, which payment methods it takes and what happens next.
- 指南Crypto POS API integration: checkout, in-store terminals and payoutsA developer's guide to crypto POS API integration: create invoices server-side, handle webhooks idempotently, take crypto in store and reconcile payouts.
