サードパーティ統合

目次

• 概要
• 使用場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

API呼び出し、エラーハンドリング、認証、データ変換のための標準化されたパターンを使用して、外部サービスとの堅牢な統合を構築します。

使用場面

• 決済プロセッサーの統合（Stripe、PayPal）
• メッセージングサービスの使用（SendGrid、Twilio）
• 分析プラットフォームへの接続（Mixpanel、Segment）
• ストレージサービスとの同期（AWS S3、Google Cloud）
• CRMシステムの統合（Salesforce、HubSpot）
• マルチサービスアーキテクチャの構築

クイックスタート

最小限の動作例：

const axios = require("axios");

class ThirdPartyClient {
  constructor(config) {
    this.apiKey = config.apiKey;
    this.baseUrl = config.baseUrl;
    this.timeout = config.timeout || 30000;
    this.retryAttempts = config.retryAttempts || 3;
    this.retryDelay = config.retryDelay || 1000;
    this.client = axios.create({
      baseURL: this.baseUrl,
      timeout: this.timeout,
      headers: {
        Authorization: `Bearer ${this.apiKey}`,
        "Content-Type": "application/json",
      },
    });
  }

  async request(method, endpoint, data = null, options = {}) {
    let lastError;

    for (let attempt = 0; attempt < this.retryAttempts; attempt++) {
      try {
        const response = await this.client({
// ... (詳細な実装はリファレンスガイドを参照)

リファレンスガイド

references/ ディレクトリの詳細な実装：

ベストプラクティス

✅ すべき事

• 指数バックオフを含むリトライロジックを実装する
• Webhookの署名を検証する
• すべてのAPI操作をログに記録する
• シークレットに環境変数を使用する
• API レスポンスを内部モデルに変換する
• 重要なサービスに対してサーキットブレーカーを実装する
• API クォータとレート制限を監視する
• 適切なエラーハンドリングを追加する
• タイムアウトを適切に使用する
• サンドボックス/テストAPIキーでテストする

❌ してはいけない事

• APIキーをハードコードする
• すべてのエラーを無限にリトライする
• 機密データをログに記録する
• 検証されていないWebhookデータを信頼する
• レート制限を無視する
• 同期的ブロッキング呼び出しを行う
• ベンダー固有の詳細をクライアントに公開する
• エラーハンドリングをスキップする
• テスト時に本番キーを使用する