SuperAPI AI 工具集

erpnext-api-patterns

编程与开发

查看项目

更新于 10-16 06:17

技能介绍

用途:在构建 ERPNext/Frappe(v14/v15/v16)API 集成时提供参考,覆盖 REST API、RPC API、认证、Webhook 与限流。

主要能力:给出 API 类型决策树——文档 CRUD 用 REST API /api/resource/{doctype};调用自定义业务逻辑用 RPC API /api/method/{path};事件通知外部系统配置 Webhook;客户端调用服务端用 frappe.call() 或 frappe.xcall()。速查表列出 REST CRUD 的方法与端点(GET/POST/PUT/DELETE)、过滤操作符(=、>、in、between、is set)、RPC 方法需 @frappe.whitelist() 装饰器、响应结构(REST 为 {"data": {...}},RPC 为 {"message": ...})及错误结构与 HTTP 状态码(200/400/401/403/404/417/429)。

使用方式:认证推荐 Token Auth,请求头为 'Authorization': 'token api_key:api_secret',并附 Accept 与 Content-Type;OAuth2 用 Bearer Token。客户端推荐 await frappe.xcall(...) 异步写法。

关键规则:始终带 Accept: application/json;白名单方法内加权限检查;不硬编码凭据,改用 frappe.conf;避免 SQL 注入;只读用 GET,改变状态用 POST。

版本差异:expand_links 参数与 Server Script 限流仅 v15 支持,OAuth2 PKCE 在 v15 完善。

限制:资料未提供具体安装命令、收费信息与完整示例代码,相关细节暂未提供。