ToolJet 集成 WooCommerce 数据源指南连接配置、资源操作与源码实现解析【免费下载链接】ToolJetOpen-source foundation of ToolJet AI - the enterprise app generation platform for internal tools, dashboards, business applications, workflows and AI agents. Build visually, from a prompt, or from Claude Code, Codex and Cursor over MCP 项目地址: https://gitcode.com/GitHub_Trending/to/ToolJetToolJet 提供了开箱即用的 WooCommerce 数据源插件让你无需编写后端代码即可在内部工具、仪表盘与业务应用中直接读取和写入 WooCommerce 商店数据客户、商品、订单与优惠券。本文将基于 ToolJet 3.0.0-LTS 版本文档结合仓库内 WooCommerce 插件源码 与 manifest 配置完整讲解从建立连接、发起查询到各资源操作参数的实战流程并揭示插件底层如何将操作映射为 WooCommerce REST API 调用。前置准备获取 WooCommerce 的 Consumer Key 与 Consumer Secret在 ToolJet 中连接 WooCommerce 之前需要先到你的 WooCommerce 后台生成 API 密钥登录 WooCommerce 站点管理后台Admin Dashboard进入WooCommerce → Settings → Advanced → REST API或 Advanced → API Keys点击Add key填写描述、选择权限Read / Write / Read/Write点击Generate API key页面会一次性展示Consumer key与Consumer secret请立即保存——Secret 只在生成时完整显示一次。注密钥的生成方式与认证细节以 WooCommerce 官方 REST API 文档Authentication 章节为准详见 plugins/packages/woocommerce/README.md 中的指引。建立 WooCommerce 连接在 ToolJet 中建立 WooCommerce 数据源连接有两种入口在应用编辑器的查询面板Query Panel中点击 Add new Data source按钮或从 ToolJet 仪表盘导航到 Data Sources 页面选择WooCommerce作为数据源类型。ToolJet 连接 WooCommerce 需要三个必填参数参数说明字段类型Host你的 WooCommerce 商店 URL如https://your-store.com文本Consumer key后台生成的 Consumer key密码加密存储Consumer secret后台生成的 Consumer secret密码加密存储从 manifest.json 可以看到三个字段在数据源表单中的具体定义consumer_key与consumer_secret被声明为type: password且带encrypted: true标记说明密钥在保存时会经过 ToolJet 的加密机制处理后才入库host为普通文本字段。三者均被列入required数组任一缺失都会阻止连接创建。连接背后的实现基于 woocommerce-rest-ts-api 的 REST 客户端插件在 getConnection 方法 中通过woocommerce-rest-ts-api库构造 REST 客户端const WooCommerce new WooCommerceRestApi({ url: host, // 商店 URL consumerKey: consumer_key, consumerSecret: consumer_secret, version: wc/v3, // WooCommerce WP REST API 版本 });这里固定使用 WooCommerce REST API 的wc/v3版本插件通过 HTTP 与你的商店站点交互因此 Host 需要是公网可达或 ToolJet 所在网络可达的商店地址。连接测试逻辑插件实现了testConnection见 index.ts它会向system_status端点发起一次GET请求若请求失败或返回状态码401则抛出Invalid credentials错误——这就是你在数据源表单点击 Test Connection 时看到的结果反馈。因此填错 Host、Key 或 Secret 时会被明确提示为凭据无效。发起对 WooCommerce 的查询连接建立后在应用编辑器中按以下步骤发起查询点击编辑器底部查询管理器Query Manager的 Add按钮选择上一步添加的WooCommerce数据源从下拉框选择目标资源Resource再选择对应的操作Operation并填写所需参数点击Preview按钮预览输出或点击Run按钮触发查询结果会写入查询的data变量供组件绑定使用。提示查询结果可以通过 ToolJet 的**转换Transformations**能力做二次加工例如筛选字段或重组数据结构详见 transformations 文档。查询分发机制Resource → Operation 的映射在插件入口 index.ts 的run方法中ToolJet 根据resource字段将请求分发到四组操作处理器customer、product、order、coupon。每个处理器再根据operation字符串决定实际调用的 REST 端点与 HTTP 方法GET/POST/PUT/DELETE详见 operation.ts。list类操作会通过querystring.stringify把非空参数拼接为查询串见 generateEndpointWithQueryParams未填写的参数会被自动忽略create/update/batch_update类操作则将 Body 参数按JSON5格式解析后作为请求体提交delete操作固定携带force: true强制删除。支持的资源与操作Customer客户支持的操作list customer— 列出客户update customer— 更新客户delete customer— 删除客户强制删除batch update customer— 批量更新客户create customer— 创建客户retrieve customer— 获取单个客户list customer 支持的过滤/排序参数对应 REST 端点GET /customers见 operation.ts参数说明context请求上下文如viewpage当前页码默认 1per_page每页条数默认 10最大 100search按关键词搜索exclude排除指定 ID 列表include仅包含指定 ID 列表offset偏移量跳过前 N 条order排序方向asc/descorderby排序字段id/include/name/registered_date等email按邮箱精确过滤role按用户角色过滤如customerupdate / retrieve / delete customer需要额外填写customer_id参数分别映射到PUT /customers/{id}、GET /customers/{id}、DELETE /customers/{id}create customer与batch update customer通过 Body 提交客户数据后者对应POST /customers/batchBody 结构为{create: [...], update: [...], delete: [...]}。Product商品支持的操作list product— 列出商品update product— 更新商品delete product— 删除商品强制删除batch update product— 批量更新商品create product— 创建商品retrieve product— 获取单个商品list product 支持的过滤/排序参数端点GET /products见 operation.ts参数说明context/page/per_page/search/exclude/include/offset/order/orderby与 Customer 的通用分页、搜索、排序参数一致slug按商品别名过滤status按商品状态过滤draft/pending/private/publish等type按商品类型过滤simple/grouped/external/variablesku按 SKU 精确过滤featured是否仅返回精选商品true/falsecategory按分类 ID 过滤tag按标签 ID 过滤shipping_class按配送类别过滤attribute按属性过滤attribute_term按属性项过滤tax_class按税率类别过滤on_sale是否仅返回促销商品min_price/max_price价格区间过滤stock_status按库存状态过滤instock/outofstock/onbackorderbefore/after按日期过滤ISO8601 格式parent/parent_exclude按父商品 ID 过滤 / 排除商品类单条操作同样需要product_id参数Body 用于 create/update/batch update对应端点POST /products、PUT /products/{id}、POST /products/batch、GET /products/{id}、DELETE /products/{id}。Order订单支持的操作list order— 列出订单update order— 更新订单delete order— 删除订单强制删除batch update order— 批量更新订单create order— 创建订单retrieve order— 获取单个订单list order 支持的过滤/排序参数端点GET /orders见 operation.ts参数说明context/page/per_page/search/exclude/include/offset/order/orderby通用分页、搜索、排序参数status按订单状态过滤pending/processing/on-hold/completed/cancelled/refunded/failed/trash等before/after按下单日期过滤parent/parent_exclude按父订单过滤 / 排除customer按客户 ID 过滤product按包含的商品 ID 过滤dp小数位数决定金额精度的显示订单类单条操作使用order_id参数对应端点GET /orders/{id}、PUT /orders/{id}、DELETE /orders/{id}批量操作为POST /orders/batch创建为POST /orders。Coupon优惠券支持的操作list coupon— 列出优惠券create coupon— 创建优惠券list coupon 支持的过滤/排序参数端点GET /coupons见 operation.ts参数说明context/page/per_page/search/exclude/include/offset/order/orderby通用分页、搜索、排序参数before/after按有效期日期过滤code按优惠券代码过滤create coupon通过 Body 提交优惠券数据如code、discount_type、amount、individual_use等对应POST /coupons。源码视角插件数据结构与扩展点从类型定义 types.ts 可以看出插件将所有查询参数集中在QueryOptions中其中operation、resource、body以及各类*_id是核心字段其余参数为可选的列表过滤条件。body参数统一使用 JSON5 解析见 operation.ts因此你可以在 Body 中直接编写带注释或宽松语法的 JSON容错性更高。数据源创建后ToolJet 会在查询执行时向插件暴露三个内置变量isLoading、data、rawData见 manifest.json便于在应用中对查询状态与结果进行绑定和展示。插件位于 plugins/packages/woocommerce 目录属于 ToolJet 插件体系中的tooljet-plugins/woocommerce包依赖woocommerce-rest-ts-api^7.0.0见 package.json。如果你需要排查问题或了解插件如何被加载可以从该目录入手阅读实现。常见问题与使用建议连接测试失败并提示 Invalid credentials优先检查 Consumer key / Secret 是否正确复制Secret 生成后只显示一次若丢失需在 WooCommerce 后台重新生成并确认 Host 填写的 URL 与商店实际地址一致。希望查询更快更精准在list类操作中尽量使用per_page、page控制返回规模用search、status、category等条件缩小结果集避免一次拉取全量数据拖慢应用。批量维护数据涉及大量客户、商品或订单的增改删时优先使用batch update操作一次提交多条记录减少请求往返次数。对结果做二次加工结合 ToolJet 的 transformations 功能将返回的原始数据裁剪、聚合为组件所需的形状再绑定到表格、图表等控件上。【免费下载链接】ToolJetOpen-source foundation of ToolJet AI - the enterprise app generation platform for internal tools, dashboards, business applications, workflows and AI agents. Build visually, from a prompt, or from Claude Code, Codex and Cursor over MCP 项目地址: https://gitcode.com/GitHub_Trending/to/ToolJet创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考