概要

各Zoom API のエンドポイントは、Zoom APIリファレンス内に、テスト用のウィジェットが用意されています。このツールは、APIの機能やレスポンスを理解するために、ドキュメントとテストツールを切り替えずに、簡単にテストする手段を提供することを目的としています。

この記事では、OAuth 2.0を使ってテストツールを動かす方法を紹介します。

この記事の内容：

• OAuthアプリを登録する
• アプリに許可するScopeを決定する
• テストリクエストを送信する

前提条件

• 「役割の管理」でデベロッパー向けZoomの権限を付与したユーザーアカウント

OAuthアプリを登録する

1. アプリマーケットプレイスへアクセスし、サインインします。
2. アプリ登録画面へ移動し「Build App」をクリックします。
3. 「OAuth」を選択し「Create」をクリックします。
4. アプリ名を入力し、用途に応じて「Account-level app」「User-managed app」選択します。アプリマーケットプレイスに公開する予定がなければ、「Wouldyou like to publish」を無効にします。
5. 「Create」をクリックします。
6. 登録したアプリのApp Credentialsが表示されます。「Client ID」「Client Secret」がAPI呼び出しに必要となる値です。
   
   
7. 「Redirect URL for OAuth」「Whitelist URL」に有効なURLを記載し、「Continue」をクリックします。
   Note:  特に用意していない場合 "https://marketplace.zoom.us/docs/oauth/callback/success" を入力することで動作確認することができます。
8. 「Information」にアプリケーションの説明を記載します。以下は必須項目です。
   • Basic Information：「Company Name」
   • Developer Contact Information：「Name」「Email Address」
9. 必要に応じて「Event subscription」を有効にします。詳細はこちら
10. 「Scope」でアプリケーションに許可するリソースの範囲を指定します。詳細はこちら
11. 「Activation」で「Install」をクリックします。

アプリに許可するScopeを決定する

API-Referenceの各APIに必要な権限の説明があります。これはアプリで必要となる「Scope」を決定するのに役立ちます。

1. APIリファレンスのページへ移動します
2. 使用するAPIのページへ移動します。
3. Scopes：の値を確認します。(以下は、List Users の例)
   
   

テストリクエストを送信する

API-Referenceから各APIのテストリクエストを送信できます。

1. APIリファレンスのページへ移動します
2. 使用するAPIのページへ移動します。
3. 下にスクロールし「Send a Test Request」まで移動します。
4. 「Get Access Token」をクリックします。
   
   
5. 「OAuthアプリを登録する」で入手した「Client ID」「Client Secret」を入力し、「Get Access Token」をクリックします。
   
   
6. アクセストークンが取得できます。
   
7. 必要なパラメータをセットして、「Send」をクリックするとリクエストが送信できます。