rivet-sdk

Zoom Rivet SDK

Zoom 連携向けの JavaScript および TypeScript サーバーフレームワークである Zoom Rivet の背景情報です。

次の用途におけるサーバーサイドフレームワークとしての Zoom Rivet（JavaScript／TypeScript）の実装ガイダンスです。

• OAuth とトークンの処理
• Webhook イベントの受信
• 型付き REST API エンドポイントラッパー
• 複数モジュールのサーバー構成

公式ドキュメント：

• https://developers.zoom.us/docs/rivet/
• https://developers.zoom.us/docs/rivet/javascript/
• https://zoom.github.io/rivet-javascript/

参考サンプル：

• https://github.com/zoom/rivet-javascript-sample
• https://github.com/zoom/isv-rivet-starter
• https://github.com/zoom/Rivet-Server-Sample
• https://github.com/zoom/rivet-javascript

ルーティングのガードレール

• Rivet SDK は、Zoom の認証処理、Webhook 受信機、型付き API ラッパーをまとめた Node.js フレームワークです。
• Rivet はサーバーサイドの迅速な足場作りに推奨されますが、必須ではありません。
• 計画の開始時に、次の希望を確認してください。
• Do you want Rivet SDK, or direct OAuth + REST without Rivet?
• 最小限の接着コードで Zoom の認証、Webhook、API 呼び出しを組み合わせる Node.js サーバーをユーザーが希望する場合は、Rivet を使用します。
• 既存のバックエンドからの直接 API 呼び出しだけが必要な場合は、../rest-api/SKILL.md と組み合わせます。
• Zoom Team Chat アプリのカード／コマンドの動作に重点を置いている場合は、../team-chat/SKILL.md と組み合わせます。
• SDK の埋め込み（Meeting SDK／Video SDK のクライアントランタイム）が必要な場合は、../meeting-sdk/SKILL.md または ../video-sdk/SKILL.md に案内します。

クイックリンク

まずはこちら：

1. concepts/architecture-and-lifecycle.md
2. scenarios/high-level-scenarios.md
3. examples/getting-started-pattern.md
4. examples/multi-client-pattern.md
5. references/rivet-reference-map.md
6. references/versioning-and-compatibility.md
7. references/samples-validation.md
8. references/source-map.md
9. references/environment-variables.md
10. troubleshooting/common-issues.md
11. RUNBOOK.md
12. rivet-sdk.md

一般的なライフサイクルパターン

1. モジュールごとにモジュールと認証モデル（Client Credentials、User OAuth、S2S OAuth、Video SDK JWT）を選択します。
2. 認証情報、Webhook シークレット、モジュールごとのポートを指定して、クライアントをインスタンス化します。
3. イベントハンドラー（webEventConsumer.event(...) またはショートカット）を登録します。
4. client.endpoints.* を通じて API 呼び出しを実装します。
5. 受信機を起動し、Webhook エンドポイント（/zoom/events）を Zoom に公開します。
6. OAuth を使用する処理のトークン／状態を永続化し、署名検証を必ず行います。
7. モジュール固有の障害を監視し、変更履歴の更新サイクルに合わせてシークレットやバージョンをローテーションします。

概要シナリオ

• Team Chat のスラッシュコマンドボットと Team Chat データ API による情報拡充。
• 1 つのプロセスを共有する複数モジュールのバックエンド（Users + Meetings + Team Chat + Phone）。
• videosdk モジュールのイベントストリームと API サーフェスを使用する Video SDK テレメトリバックエンド。
• テナント対応のトークンストレージとモジュールごとの Webhook を備えた ISV オーケストレーションレイヤー。
• Rivet の AwsLambdaReceiver を使用する AWS Lambda Webhook プロセッサー。

詳細は scenarios/high-level-scenarios.md を参照してください。

連携先

• OAuth アーキテクチャとグラントの選択：../oauth/SKILL.md
• API エンドポイントの仕様とリクエストペイロードの詳細：../rest-api/SKILL.md
• Team Chat アプリのカード、コマンド、ボットの UX：../team-chat/SKILL.md
• Video SDK 固有の API の動作と BYOS のコンテキスト：../video-sdk/SKILL.md

環境変数

• 標準化された .env キーと各値の確認場所については、references/environment-variables.md を参照してください。

運用

• RUNBOOK.md - 5 分で確認できる事前チェックとデバッグ用チェックリスト。