SuperAPI AI 工具集

kuroco-external-integration-design

设计与创作

查看项目

更新于 10-15 21:10

技能介绍

用途:在选定外部系统对接模式(直接调用/代理/导入)之后,深入梳理落地时需确认与注意的设计要点,供设计判断参考。

三种模式的构成与适用:直接调用由前端直接调用外部 API,Kuroco 不参与;代理经自定义端点的 Smarty 模板用 {api} 插件调用外部 API 并返回;导入则先把外部数据取入 Topics/CSV 表,再用标准 Topics API 提供。

主要能力与用法:代理模式插件名为 {api}(不存在 api_request),主要参数含 endpoint、method、headers、json_body/body、files(一次仅 1 个文件)、timeout(如 60,默认值与上限资料未确认)、sslcert/sslkey/cainfo(值为密钥名)。密钥与 Webhook 秘密 URL 用 {secret} 插件读取($smarty.const.* 仅用于非机密配置)。

导入模式:结构化 API 的定期获取宜用批处理 {api} 配合 {api_internal} 写入 Topics,而非爬虫;爬虫面向网页与文件等非结构化数据。批量免费额度在未登记支付信息时约每小时 100 次。外部推送可考虑 Webhook 或触发邮箱(如 {号码}@twilio.r-cms.jp 发信即发 SMS),可能无需写 Smarty。

限制:{api} 超时默认值与自定义端点整体执行时间上限资料未确认,慢速外部 API 建议实测或改用批处理;Smarty 无法写入 {secret},需轮换的令牌可选即时获取(JIT)或存于受保护的 Topics 记录;api_token 与外部 OAuth 令牌管理无关。长有效令牌仍可能过期(如 Instagram Basic Display 长期令牌 60 天失效),须设计更新批处理。