ベストプラクティス
システム連携

システム連携

TWPと外部システムを連携する際のポイントを説明します。

連携方式

API連携

TWP APIを使用して、外部システムとデータを連携できます。

  • RESTful API
  • JSON形式
  • JWT認証

SSO連携

既存の認証基盤と連携して、シングルサインオンを実現できます。

  • Microsoft Azure AD
  • Google Workspace

API連携のポイント

エラーハンドリング

API呼び出し時は、適切なエラーハンドリングを実装してください。

try {
  // API呼び出し
} catch (error) {
  if (error.status === 401) {
    // トークン更新
  } else if (error.status === 429) {
    // レート制限対応
  }
}

レート制限への対応

レート制限を超えないよう、以下の対策を推奨します。

  • リクエストの間隔を空ける
  • 必要なデータのみ取得
  • キャッシュの活用

べき等性

POST/PUT/DELETEリクエストは、リトライ時に重複処理が発生しないよう考慮してください。

Webhook連携

TWPからのイベント通知を受け取ることができます。

対応イベント

  • タスクのステータス変更
  • ワークフローの承認・却下
  • ファイルのアップロード

実装のポイント

  • 署名検証を実装
  • 非同期処理を推奨
  • 冪等性を考慮

SSO連携

Microsoft Azure AD

  1. Azure ADにアプリケーションを登録
  2. TWP管理画面でSSO設定
  3. リダイレクトURLを設定

Google Workspace

  1. Google Cloud Consoleでプロジェクト作成
  2. OAuth 2.0クライアントを設定
  3. TWP管理画面でSSO設定

連携のテスト

開発環境の活用

本番環境に影響を与えないよう、開発環境でテストを行ってください。

テストデータ

テスト用のプロジェクト・タスクを作成し、連携の動作確認を行ってください。