开发者中心

六条路径,接入 ShopFaaS。

REST API、Webhook、SDK、插件、主题、AI——选择适合你的接入方式。MIT 开源,类型安全,80% 收益分成。

查看 GitHub 仓库浏览开发方向

150+

REST API 端点

覆盖全业务

80%

收益分成

开发者拿大头

开发方向

API/Webhook/SDK/插件/主题/AI

MIT

开源协议

可商用可二次开发

六大方向

选择你的接入方式

从简单的 REST API 调用到完整的插件开发,ShopFaaS 提供多层次的集成方案。

REST API

150+ 端点

覆盖商品、订单、客户、库存、营销、支付等全部业务对象。标准 RESTful 设计,OAuth2 客户端凭证授权,JSON 响应统一信封。

OAuth2 客户端凭证
统一响应信封 {code,msg,data}
分页/筛选/排序标准参数
速率限制 60 req/min

查看 API 参考

Webhook 事件

实时联动

订阅订单创建、支付成功、库存预警、客户注册等关键事件,ShopFaaS 主动推送至你的回调地址,实现与外部系统的实时联动。

HMAC-SHA256 签名校验
失败自动重试 3 次
事件版本化向后兼容
可视化订阅管理

查看 Webhook 指南

TypeScript SDK

类型安全

官方 TypeScript SDK,与后端类型同源生成,IDE 自动补全全业务对象。支持 Node.js 与浏览器环境,开箱即用。

类型同源自动生成
Promise + async/await
自动刷新 token
内置重试与错误处理

查看 SDK 文档

插件系统

80% 收益分成

强隔离 Web Worker 沙箱运行,权限声明模型(plugin.json.permissions),开发商店机制。上架应用市场,开发者获得 80% 收益分成。

IsolatedWorker 沙箱隔离
ResourceHandler 资源配额
权限声明模型
应用市场分发渠道

查看插件开发指南

主题开发

Liquid 模板

基于 Liquid 模板引擎的主题系统,商家可自定义店铺前端。提供标准主题骨架与组件库,支持多语言多币种开箱即用。

Liquid 模板引擎
主题配置 schema 声明
多语言多币种
主题市场分发

查看主题开发指南

AI 集成

LLM 经营洞察

内置 AI 智能运营模块,接入 OpenAI/Anthropic/Azure/自定义 endpoint,基于经营数据生成结构化洞察。用户自带 API key,平台不抽成。

支持 4 大 LLM provider
结构化经营洞察输出
API key 服务端加密
连接测试与调试

查看 AI 能力

四步上手

从注册到上架,只需四步

注册店铺

免费注册获得体验店铺,获取 API 凭证

创建应用

在后台创建应用,声明权限范围,获取 client_id/secret

安装 SDK

npm install @shopfaas/sdk,配置凭证即可调用

上架分发

开发完成提交审核,通过后上架应用市场获得分润

代码示例

三行代码调用 API

TypeScript SDK 类型安全,IDE 自动补全,与后端类型同源生成。

example.ts

import { ShopFaaS } from "@shopfaas/sdk";

const client = new ShopFaaS({
  shopId: "shop_xxx",
  clientId: "app_xxx",
  clientSecret: process.env.SHOPFAAS_SECRET,
};

// 创建商品
const product = await client.products.create({
  title: "限量卫衣",
  price: 199,
  variants: [
    { sku: "HOODIE-BLK-M", stock: 100 },
    { sku: "HOODIE-WHT-L", stock: 50 },
  ],
});

// 订阅订单事件 Webhook
await client.webhooks.subscribe({
  topic: "order.created",
  endpoint: "https://your-app.com/webhook",
});

准备好构建了?

免费注册店铺获取 API 凭证,或在 GitHub 查看完整源码与文档。

免费注册获取凭证加入开发者社区