building-sf-integrations について
ランタイム接続、認証、コールアウト、イベント駆動パターンを扱うSalesforce連携設計スキルです。方式の選択と検証を支援し、認証情報、サービス、Apexコールアウト、Platform Events、CDCのテンプレートを備えています。
主な機能
- 01NamedおよびExternal Credentialのパターン
- 02RESTとSOAPコールアウトのガイド
- 03External Service設定のガイド
- 04Platform EventsとCDCのパターン
- 05テンプレートと連携検証
活用シーン
- 01認証付き外部API呼び出しの設計
- 02同期・非同期コールアウト方式の選択
- 03イベント駆動連携の計画
- 04認証情報とコールアウト成果物の準備
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ forcedotcom/ sf-skills --skill building-sf-integrationsインストール後、Claude Code で/building-sf-integrationsを入力して読み込まれたか確認します。
同梱ファイル
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詳細
building-sf-integrations:Salesforce 統合パターンのエキスパート
ユーザーが統合アーキテクチャと実行時の連携を必要としている場合に、このスキルを使用します。Named Credentials、External Credentials、External Services、REST/SOAP コールアウトのパターン、Platform Events、CDC、イベント駆動型の統合設計が対象です。
このスキルが担当するタスク
次の作業が含まれる場合は、building-sf-integrations を使用します。
.namedCredential-meta.xmlまたは External Credential メタデータ- アウトバウンド REST/SOAP コールアウト
- OpenAPI 仕様からの External Service の登録
- Platform Events、CDC、イベント駆動型アーキテクチャ
- 同期と非同期の統合パターンの選択
次の場合は、別のスキルに委任します。
- OAuth アプリ自体の設定 → configuring-connected-apps
- Apex のみのビジネスロジックの作成 → generating-apex
- メタデータのデプロイ → deploying-metadata
- データのインポート/エクスポート → handling-sf-data
まず確認する必須コンテキスト
次の情報を確認するか、推定してください。
- 統合方式:アウトバウンドコールアウト、インバウンドイベント、External Service、CDC、Platform Event
- 認証方式
- 同期/非同期の要件
- システムのエンドポイント/仕様の詳細
- レート制限、再試行の要件、障害許容度
- 新規設計か、既存の統合の修復か
推奨ワークフロー
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. デプロイまたは実装の詳細を引き継ぐ
次を使用します。
- デプロイには deploying-metadata
- サービス/再試行コードの詳細な実装には generating-apex
- 宣言的な HTTP コールアウトのオーケストレーションには generating-flow
特に重要なルール
- 認証情報をハードコードしない
- トリガーから同期コールアウトを実行しない
- タイムアウト時の動作を明示的に定義する
- 一時的な障害に備えて再試行を計画する
- アウトバウンドの量が多い場合は、ミドルウェア/イベント駆動型のパターンを使用する
- 新規開発では、サポートされている場合、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 アプリの設定 | configuring-connected-apps | コンシューマーキー/証明書/アプリ設定 |
| 高度なコールアウトサービスのコード | generating-apex | Apex の実装 |
| 宣言型 HTTP コールアウト/Flow ラッパー | generating-flow | Flow のオーケストレーション |
| インテグレーションのメタデータをデプロイする | deploying-metadata | 検証とロールアウト |
| Agentforce からインテグレーションを使用する | developing-agentforce | エージェントアクションの構成 |
リファレンスマップ
まずはこちら
- references/named-credentials-guide.md
- references/external-services-guide.md
- references/callout-patterns.md
- references/rest-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
- scripts/README.md — 自動化スクリプトの概要(configure-named-credential.sh、set-api-credential.sh)
アセットテンプレート
assets/named-credentials/— Named Credential の XML テンプレート(OAuth、JWT、Certificate、Custom auth)assets/external-credentials/— External Credential の XML テンプレート(OAuth、JWT)assets/external-services/— External Service の登録テンプレートと操作ガイドassets/callouts/— REST 同期、Queueable、再試行ハンドラー、HTTP レスポンスハンドラーの Apex テンプレートassets/platform-events/— Platform Event の定義、発行者、サブスクライバーのテンプレートassets/cdc/— CDC ハンドラーとサブスクライバーのトリガーテンプレートassets/soap/— SOAP コールアウトサービスのテンプレートと wsdl2apex ガイドassets/endpoint-security/— Remote Site Setting と CSP Trusted Site の XML テンプレート
自動化フック
hooks/scripts/suggest_credential_setup.py— インテグレーションファイルが検出されると、認証情報の設定手順を自動で提案しますhooks/scripts/validate_integration.py— エージェントの応答前にインテグレーションのパターンを検証します
出力内容
このスキルがインテグレーションタスクを完了すると、次のものが生成されます。
- 認証情報のメタデータ — 組織固有の値を入力した、
assets/named-credentials/またはassets/external-credentials/内の 1 つ以上のファイル - コールアウト Apex クラス — Named Credential パターンを使用し、コンテキストに応じて非同期/同期パターンを選択した
.clsファイル - イベント/CDC のアーティファクト — Platform Event の
.object-meta.xml、サブスクライバーのトリガー、または CDC 設定(イベント駆動型パターンを選択した場合) - エンドポイントセキュリティのメタデータ — Remote Site Setting および/または CSP Trusted Site の XML ファイル
- スコアリングレポート — 6 つのカテゴリ(セキュリティ、エラー処理、一括処理、アーキテクチャ、ベストプラクティス、ドキュメント)にわたる 120 点満点のスコア
- 次のステップ — 生成されたアーティファクトのデプロイ手順またはテスト手順
スコアガイド
| スコア | 意味 |
|---|---|
| 108+ | 本番環境に対応できる優れたインテグレーション設計 |
| 90–107 | 優れた設計ですが、強化すべき点がいくつか残っています |
| 72–89 | 実用可能ですが、アーキテクチャのレビューが必要です |
| < 72 | デプロイには安全性が不十分、または未完成です |
コメント
Markdown 対応