关于 sf-integration
sf-integration 是用于规划 Salesforce 集成架构与运行时模式的技能,涵盖凭据设计、API 调用和事件驱动方案,并关注重试、超时等运行保障。
主要功能
- 01选择同步或异步模式
- 02规划 REST 和 SOAP 调用
- 03设计凭据架构
- 04使用 Platform Events 和 CDC
- 05检查重试、超时与日志
适用场景
- 01设计经过身份验证的出站 API 调用
- 02根据 OpenAPI 规范注册 API
- 03选择事件驱动的变更流
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ jaganpro/ sf-skills --skill sf-integration安装后在 Claude Code 中输入/sf-integration确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
CREDITS.mdREADME.mdassets/callouts/callout-retry-handler.clshttp-response-handler.clsrest-queueable-callout.clsrest-sync-callout.clsassets/cdc/cdc-handler.clscdc-subscriber-trigger.triggerassets/endpoint-security/example.cspTrustedSite-meta.xmlexample.remoteSite-meta.xmlassets/external-credentials/jwt-external-credential.externalCredential-meta.xmloauth-external-credential.externalCredential-meta.xmlassets/external-services/external-service-operations.mdopenapi-registration.externalServiceRegistration-meta.xmlassets/named-credentials/certificate-auth.namedCredential-meta.xmlcustom-auth.namedCredential-meta.xmloauth-client-credentials.namedCredential-meta.xmloauth-jwt-bearer.namedCredential-meta.xmlassets/platform-events/event-publisher.clsevent-subscriber-action.clsevent-subscriber-trigger.triggerplatform-event-definition.object-meta.xmlassets/soap/soap-callout-service.clswsdl2apex-guide.mdhooks/scripts/suggest_credential_setup.pyvalidate_integration.pyreferences/callout-patterns.mdcdc-guide.mdcli-reference.mdevent-driven-architecture-guide.md详细介绍
sf-integration:Salesforce 集成模式专家
当用户需要集成架构和运行时连接配置时使用此技能:Named Credentials、External Credentials、External Services、REST/SOAP 调用模式、Platform Events、CDC 和事件驱动集成设计。
此技能负责的任务
遇到以下工作时使用 sf-integration:
.namedCredential-meta.xml或 External Credential 元数据- 出站 REST/SOAP 调用
- 根据 OpenAPI 规范注册 External Service
- Platform Events、CDC 和事件驱动架构
- 选择同步或异步集成模式
以下情况请委派给其他技能:
- 配置 OAuth 应用本身 → sf-connected-apps
- 仅编写 Apex 业务逻辑 → sf-apex
- 部署元数据 → sf-deploy
- 导入/导出数据 → sf-data
首先收集所需的上下文
请询问或推断:
- 集成方式:出站调用、入站事件、External Service、CDC、平台事件
- 身份验证方式
- 同步或异步要求
- 系统端点 / 规范详情
- 速率限制、重试预期和故障容忍度
- 这是全新设计还是修复现有集成
推荐工作流
1. 选择集成模式
| 需求 | 默认模式 |
|---|---|
| 经过身份验证的出站 API 调用 | Named Credential / External Credential + Apex 或 Flow |
| 规范驱动的 API 客户端 | External Service |
| 由触发器发起的调用 | 异步调用模式 |
| 解耦的事件发布 | Platform Events |
| 消费变更流 | CDC |
2. 选择身份验证模型
优先使用安全的运行时托管身份验证:
- Named Credentials / External Credentials
- 通过合适的凭据模型使用 OAuth 或 JWT
- 不在代码中硬编码密钥
3. 使用合适的模板生成
使用以下目录中的资源:
assets/named-credentials/assets/external-credentials/assets/external-services/assets/callouts/assets/platform-events/assets/cdc/assets/soap/
4. 验证运行安全性
检查:
- 超时和重试处理
- 由触发器发起的工作的异步策略
- 日志记录 / 可观测性
- 事件保留和订阅方影响
5. 移交部署或实现细节
使用:
高优先级规则
- 绝不硬编码凭据
- 不要从触发器进行同步调用
- 明确定义超时行为
- 为瞬时故障规划重试
- 出站流量较高时使用中间件 / 事件驱动模式
- 在支持的情况下,新开发优先采用 External Credentials 架构
常见反模式:
- 同步触发器调用
- 没有重试或死信策略
- 不记录请求/响应日志
- 将身份验证配置职责与运行时集成设计混为一谈
输出格式
完成时,按以下顺序报告:
- 选择的集成模式
- 选择的身份验证模型
- 创建或更新的文件
- 运行安全措施
- 部署 / 测试后续步骤
建议格式:
Integration: <summary>
Pattern: <named credential / external service / event / cdc / callout>
Files: <paths>
Safety: <timeouts, retries, async, logging>
Next step: <deploy, register, test, or implement>
跨技能集成
| 需求 | 委派给 | 原因 |
|---|---|---|
| OAuth 应用设置 | sf-connected-apps | consumer key / 证书 / 应用配置 |
| 高级调用服务代码 | sf-apex | Apex 实现 |
| 声明式 HTTP 调用 / Flow 封装 | sf-flow | Flow 编排 |
| 部署集成元数据 | sf-deploy | 验证和发布 |
| 在 Agentforce 中使用集成 | sf-ai-agentscript | Agent 操作组合 |
参考索引
从这里开始
- references/named-credentials-guide.md
- references/external-services-guide.md
- references/callout-patterns.md
- references/security-best-practices.md
事件驱动 / 平台模式
- references/event-patterns.md
- references/platform-events-guide.md
- references/cdc-guide.md
- references/event-driven-architecture-guide.md
- references/messaging-api-v2.md
CLI / 自动化 / 评分
- references/cli-reference.md
- references/named-credentials-automation.md
- references/scoring-rubric.md
- assets/
评分指南
| 分数 | 含义 |
|---|---|
| 108+ | 强健、可用于生产环境的集成设计 |
| 90–107 | 设计良好,但仍需进行一些加固 |
| 72–89 | 可行,但需要进行架构审查 |
| < 72 | 部署时存在风险 / 尚不完整 |
评论
支持 Markdown