SuperAPI AI 工具集

frappe-impl-integrations

编程与开发

查看项目

更新于 10-15 22:17

技能介绍

用途:面向 Frappe v14/v15/v16 的集成实现指南,覆盖 OAuth、Connected App、Webhook、支付、数据导入导出与外部 API 调用。

主要能力:提供决策树判断集成模式(外部调用你的站点、你的站点调用外部、批量数据、支付、实时/批处理)。OAuth 2.0 提供方:在 OAuth Provider Settings 与 OAuth Client 配置 App Name、Scopes、Redirect URIs、Grant Type(推荐 Authorization Code)、Response Type 等,使用端点 /api/method/frappe.integrations.oauth2.authorize、get_token、openid_profile。Connected App 作为消费者:配置 OpenID Configuration URL、Authorization URI、Token URI、Redirect URI、Client ID/Secret、Scopes,代码中通过 get_oauth2_session() 发起认证请求。Webhook:配置 DocType、Doc Event(on_update、after_insert、on_submit、on_cancel、on_trash)、Request URL、Request Method、Conditions、Headers、数据格式(Form URL-encoded 或 JSON 模板),支持 Webhook Secret 的 HMAC-SHA256 签名校验,并提供接收端验证示例。外部 API 调用:使用 make_get_request/make_post_request 或 requests,强调超时、try/except 与 frappe.log_error()。数据导入:通过 Data Import DocType 选择 DocType、Import Type、下载模板、上传预览后开始导入,支持 CSV/XLSX;也可通过 DataImport 程序化导入。数据导出:Report Builder、bench export-csv/export-doc/export-json/export-fixtures 或 frappe.get_all() 程序化导出。认证:API Key+Secret、OAuth Bearer Token、Session 登录三种 REST API 认证方式。同步/异步模式与重试模式:同步、frappe.enqueue()、Webhook、定时任务、Socket.IO 实时更新及带最大重试次数的异步重试实现。

必要用法:按各工作流步骤在界面或代码中配置对应 DocType;OAuth 生产环境使用 HTTPS,服务端应用使用 Authorization Code,不暴露 client_secret;Google API 加 access_type=offline 获取刷新令牌;Webhook 生产启用 Secret,接收端做幂等;外部请求设超时并包装错误日志;不在 validate/before_save 调用外部 API,改用 on_update + frappe.enqueue();导入先下载模板、单次不超 5000 行,先小样本测试并检查 Import Log。

限制:资料未提供具体收费、价格、平台可用性或效果数据;版本差异仅列出部分功能对照,其余暂未提供。