SuperAPI AI 工具集

frappe-core-api

编程与开发

查看项目

更新于 10-15 22:17

技能介绍

用途:为 ERPNext/Frappe(v14/v15/v16)的 API 集成提供确定性模式,涵盖 REST、RPC、Webhook、认证与限流。

主要能力:给出决策树,按需求选择 CRUD、RPC、Webhook 或客户端调用;列出 REST 资源 CRUD 的 v14 与 v15+ v2 端点对照(如 /api/resource/{doctype} 与 /api/v2/document/{doctype});说明列表参数(fields、filters、or_filters、order_by、limit_start、limit_page_length、limit、debug)与过滤操作符(=、!=、>、<、>=、<=、like、not like、in、not in、is、between);提供分页、含子表创建、部分更新、文件上传示例;RPC 部分说明 @frappe.whitelist 装饰器选项(allow_guest、methods、xss_safe)与响应结构;客户端调用推荐 frappe.xcall,也支持 frappe.call 与 frm.call;列出 frappe.client 标准方法;Webhook 事件(after_insert、on_update、on_submit、on_cancel、on_trash、on_update_after_submit、on_change)与 HMAC-SHA256 签名校验。

认证方式:Token Auth(推荐,Authorization: token api_key:api_secret)、Basic Auth、OAuth 2.0(授权码、换取令牌、刷新)、Session/Cookie(约 3 天过期,不建议长期集成)。

使用方式:请求需带 Accept: application/json;whitelist 方法内做权限校验与输入校验;使用参数化查询;外部请求设 timeout=30;凭据放 frappe.conf 或环境变量;列表必须分页;Webhook 必须校验签名。

限制与注意:allow_guest=True 不得用于状态变更端点;不要用 Administrator 的 API key 做集成;避免同步重处理,长任务用 frappe.enqueue()。版本差异方面,v2 端点、limit 别名、PKCE、Server Script 限流、v2 文档方法等仅 v15+ 提供。资料未提供具体收费、价格与平台信息。