WordPress 外掛整合 Zoom API

目錄

Zoom 是許多線上課程所採用的直播平台,但直到最近我才發現 Zoom 的 Marketplace 已經有超過上千個應用程式可以使用,把我嚇得屁滾尿流,有了這些 App 可以整合許多第三方的服務,像是在線上會議時舉辦投票、根據播放時間做筆記,還可以做文件的簽署以及客戶關係管理,裡面甚至還有多款小遊戲來增進視訊時的互動,好像還滿適合英語補習班老師的XD

雖然 Zoom 與中國政府之間的關係一直被熱議,我自己也是用 Google Meet 優先於 Zoom,但還是不乏許多知名廠商也有上架它們的 App,像是 Google、Dropbox、HubSpot 等,這多虧 Zoom 強大的 API,當然 WordPress 也不會缺席,目前市集上有幾款與 WordPress 有關的 App,比較值得一提的是這款:

Integration for WordPress

這支外掛可以讓你在後台直接管理 Zoom 的會議、研討會、使用者以及報告,並且可以使用短碼、區塊編輯器或是 Elementor 來新增加入會議的前台畫面顯示,還可以匯入 Zoom 裡面既有的會議資料,比較特別的是它提供不透過 Zoom App 就能直接在瀏覽器上加入會議的功能,這對於不想另外安裝 Zoom 應用程式的朋友來說還滿方便的,查了文件才知道 Zoom 有 Web SDK 可以實現這功能。

它的付費功能也很豐富,可以排程建立會議與研討會,這對於有安排固定直播時間的老師來說可以省下重複建立的時間,另外還可以增加註冊會議功能,更能有效控管參與人員的資料,以便做好客戶關係管理。

此外還有不少擴充套件,像是整合 WooCommerce 讓顧客可以透過購買商品來取得加入線上會議的資格,以及整合其他三款 WooCommerce 的預約外掛,如果你要透過 Zoom 做一對一的線上教學會非常方便。

這支外掛也有上架 WordPress.org,但名稱不太一樣,叫做 Video Conferencing with Zoom,外掛頁的介紹與資訊都比 Zoom Marketplace 豐富,有需要的話直接從 WordPress 後台下載安裝比較快。

Zoom URL Schema

如果你並沒有想直接在 WordPress 後台管理 Zoom 的會議也沒打算賣線上研討會,你單純只是想有個按鈕可以讓瀏覽者啟動會議,那麼 URL Schema 是一個選擇,只要使用以下的網址即可:

// 電腦版
<a href="zoommtg://zoom.us/join?confno=123&pwd=123&uname=oberonlai">點我進入會議</a>

// 手機版
<a href="zoomus://zoom.us/join?confno=123&pwd=123&uname=oberonlai">點我進入會議</a>

電腦版跟手機版前面的開頭不一樣,如果是用 Elementor 可以做兩個不同的按鈕分別在不同裝置下顯示對應的連結,連結參數 confno 指的是會議 ID,pwd 是會議密碼,而 uname 是加入會議者的名稱,uname 可以不指定讓加入會議者自行輸入。

如果你想要更貼心一點讓程式自動抓已登入使用者的名稱來做為 uname,有幾種方式可以做,第一種可以建立短碼來處理:

add_shortcode( 'zoom_link', 'generate_zoom_link' );
function generate_zoom_link( $atts ) {
    $data = shortcode_atts(
        array(
            'confno' => '',
            'pwd'    => '',
            'uname'  => ( is_user_logged_in() ) ? get_usermeta( get_current_user_id() )->display_name : '',
            'text'   => '點我進入會議',
        ),
        $atts
    );

    $output  = '';
    $output .= '<a href="' . ( wp_is_mobile() ) ? 'zoomus:' : 'zoommtg:' . '//zoom.us/join?confno=' . $data['confno'] . '&pwd=' . $data['pwd'] . '&uname=' . $uname . '">';
    $output .= $data['text'] . '</a>';
    return $output;
}

這樣就可以使用這樣的短碼來顯示會議連結:[zoom_link confo="123" pwd="456" text="加入會議"],該短碼有四個參數,confo 跟 pwd 分別為會議 ID 跟密碼,uname 預設我讓它抓已登入使用者的顯示名稱或是也可以自己指定,text 則是按鈕的顯示文字,裝置的部分我直接用 WordPress 內建的 wp_is_mobile 來判斷,這樣就省去要做兩個按鈕的時間了。

第二種方法需要用到比較多 JavaScript 的語法,基本邏輯是先在後端使用 wp_enqueue_scripts() 來把使用者名稱輸出到前端,再透過 jQuery 指定連結屬性 attr 去替換連結中的 uname 參數,這方法需要知道如何使用 jQuery 選到按鈕再修改 href 的結構,然後因為我懶,這部分有需要的話再跟我說,我再把範例寫出來。

Zoom App OAuth

如果你想要進一步讓 WordPress 網站可以整合更多 Zoom 的互動行為,像是在會員登入後同時註冊 Zoom 會議、加入會議前判斷使用者的會員資格,或是提供給有來上課的會員一些點數回饋,這些就需要客製化串接 Zoom API,他們的 API 文件非常完整,並且都有範例可以參考,串接上的體驗還滿不錯的。

但要使用 API 前必須要先進行網站驗證,藉此確保使用該 API 的網站是用經過合法授權,以下文章會有一些程式碼,但都不會太困難,主要是希望可以讓你了解 WordPress 外掛在串接第三方 API 時會有的一些流程與步驟,這樣日後萬一遇到客戶有類似的需求就能大概知道有哪些製作項目。

Zoom 提供兩種授權的方式,一種是 JSON Web Tokens (JWT),因為我沒實作過所以先跳過XD,另外一種是你一定有看過的 OAuth(Open Authorization),如果你有在某些購物網站使用 Facebook 或是 Google 帳號來進行註冊的話這就是 OAuth,當你點下 FB 註冊頁面會跳轉到 Facebook 的登入與授權頁面,完成後回到原網站就能完成註冊,由於不用再多記一筆登入帳密對於使用者來說非常方便,因此這是現在帳號授權的主流做法。

而使用 Zoom API 我們就必須透過這樣的方式來取得 Access Token,對網站來說每一次操作 Zoom 的 API 都必須要告訴 Zoom 的主機說我們是合法的使用者,Zoom 認的就是這個 Access Token,而這個 Token 也是必須要透過 API 來取得,一下是 API 一下又是 Token 的有點混淆,我們先把具體的步驟列出來:

  1. 取得授權網址
  2. 網站跳轉到授權頁面
  3. Zoom 回傳產生 Token 需要的資料
  4. 透過該資料呼叫 Zoom API 取得 Token
  5. 將 Token 存在資料庫中
  6. 利用這個 Token 進行後續的 API 操作

(一) 取得授權網址

你就想成是去購物平台點下 Facebook 登入按鈕後會跳轉的頁面,這個網址每家有自己的格式,但不外乎都是在網址上帶入一些參數,而這些參數需要靠我們自己把他填入,Zoom 的格式是這樣:

https://zoom.us/oauth/authorize?response_type=code&client_id=7lstjK9NTyett_oeXtFiEQ&redirect_uri=https://yourapp.example.com

需要替換的參數有兩個,第一個是 client_id,通常做 OAuth 都需要去該服務的後台建立一個 App,而這 App 會有 app id 跟 app secret,而 client_id 就是 app id,如何建立 Zoom OAuth App 可以參考這篇文章:https://marketplace.zoom.us/docs/guides/build/oauth-app/

第二個要替換的參數是 redirect_url,這是當完成授權後要跳轉回網站的頁面,這個頁面十分重要,因為 Zoom 會透過這個頁面把產出 Token 所需要的資料回傳給我們,所以我們要把手套準備好來接 Zoom 的回傳球,這顆球叫做 Code,有了這個 Code 才有辦法產出 Token。

當第一次進行授權時就會看到以下畫面:

這時候你就要登入你的 Zoom 帳號來同意你的網站是經過你的授權的。

(二) 取得 Token

第二步驟我們要靠跳轉回網站後的頁面也就是 redirect_uri 所設定的網址來處理取得 Token 的請求,你可以新增一個頁面叫做 zoom-callback,在業界這一類的網址我們慣稱叫做 callback url,然後新增一個 page-zoom-callback.php 的範本檔來處理。

但通常這種在處理 API 的情境我不會用頁面來做,而是改用 WordPress REST API 比較好管理,不然萬一哪天不小心手殘刪到這個頁面就 GG 了,因此我們會註冊一個新的 WordPress API 路徑來專門接受 Zoom 的回傳,並且在這個路徑中處理後續的事情。

要註冊 WordPress REST API路徑使用的是 register_rest_route 方法,然後勾點是放在 rest_api_init 上,具體範例可以參考官方手冊:https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/

路徑的名稱我把它命名為 zoom/v1/token,所以在第一步的授權網址就要填入 https://yoursite.com/zoom/v1/token

具體寫法如下:

register_rest_route(
    'zoom/v1',
    '/token',
    array(
        'methods'  => 'GET',
        'callback' => __CLASS__ . '::get_bot_api_body',
    )
);

需要注意的地方是 callback 那邊我了它一個方法叫做 get_zoom_token(),這個方法稍後會實作取得 Token 的方法,所以這邊就是註冊一個新的路徑,讓 Zoom 回傳我們產生 Token 需要的資料,接下來就交給 get_zoom_token() 來處理。

WordPress 呼叫 API 的方式是使用 wp_remote_request(),它封裝了 HTTP 請求的工具讓我們可以很方便地使用它,根據 Zoom 的文件說明它會回傳一個 Code 作為產出 Token 的基本元素,並且再組合 Zoom App 的 id 跟 Secret 來發出請求就能獲得 Token,具體寫法如下:

public static function get_bot_api_body( $request ) {
    $body    = array(
        'grant_type'   => 'authorization_code',
        'code'         => $_GET['code'],
        'redirect_uri' => 'https://yoursite.com/wp-json/zoom/v1/token',
    );
    $options = array(
        'method'  => 'POST',
        'timeout' => 60,
        'headers' => array(
            'Content-Type'  => 'application/x-www-form-urlencoded',
            'Authorization' => 'Basic ' . base64_encode( APP_ID . ':' . APP_SECRET ),
        ),
        'body'    => http_build_query( $body ),
    );

    $response = wp_remote_request( 'https://zoom.us/oauth/token', $options );

    $resp = json_decode( wp_remote_retrieve_body( $response ) );
    update_option( 'ods_zoom_access_token', $resp->access_token );
    update_option( 'ods_zoom_refresh_token', $resp->refresh_token );

    wp_safe_redirect( 'https://yoursite.com/finish-zoom-oauth' );
    exit;
}

首先 $body 是我們要傳給 Zoom 取得 API 的必要資料,其中 code 就是 Zoom 回傳給我們的,而這邊又有一個 redirect_uri 來告訴 Zoom 說當取得 Token 後會去哪個頁面,這邊範例一樣設定 API 路徑,而頁面跳轉則交給最下面的 wp_safe_redirect 來處理。

其次是 API 請求的設定,根據文件我們要用 POST 方法以及 application/x-www-form-urlencoded 的格式來傳送,而 Authorization 驗證方法是用 Basic 加上 App ID 與 SECRET 的 base64 的加密方式來處理,這聽起來有點複雜,但 Zoom 文件都有範例可以複製貼上,只要置換裡面的變數即可。

最後使用 wp_remote_request 去呼叫 https://zoom.us/oauth/token 這一個取得 Token 的 API 網址,得到回傳結果後再去解析我們要的 Token,這樣我們就能得到 API 要用的 Access Token 來做事了,我這邊用 update_option 來寫進資料庫中,之後要用這個 Token 就用 get_option( ‘ods_zoom_access_token’ ) 取得即可。

另外你可能會好奇還有一個 refresh_token 是幹嘛用的,它的目的是讓你不用透過授權網址就能取得 Access Token,基於安全理由 Access Token 會有使用期限,所以我們要定期的去更換它,但總不能每次都要人工手動去點授權網址來取得,因此就能透過 Refresh Token 呼叫 Zoom API 來自動重新更換 Access Token。

以上就是 Zoom API OAuth 授權的步驟,範例中簡化了許多程式細節,主要目的是希望透過這樣的文章介紹有哪些好用的現成外掛,還能學到一些關於程式開發的流程與知識,讓你之後跟客戶溝通需求或是交辦任務給工程師時能有一個大方向來進行說明,如果你想了解更多 WordPress 開發的技術邏輯再跟我說吧!

文章標籤APIZoom

目錄

賴俊吾 / Oberon Lai
賴俊吾 / Oberon Lai

現為全職 WordPress 工程師,網站開發經歷 11 年,專攻前端工程與 WordPress 佈景主題、外掛客製化開發

訂閱電子報

Hi,我是 Oberon,我會固定在每週五早上發送接案心得以及與 WordPress 相關的電子報,同時也會分享一些實用的開發知識,讓你在 WordPress 的接案路上不孤單!

覺得文章寫得好再幫我鼓個掌吧!

相關文章

四個值得 WordPress 開發者訂閱的電子報

以前我很喜歡訂閱電子報,尤其是各家 SaaS 服務為了維繫客戶,都會固定發送很有料的電子報來吸引會員,曾經有一陣子我想學電子報行銷...

wpack.io 帶你突破 WordPress 前端程式開發的困境

前些年工作主力還集中在客製化 WordPress 佈景主題開發的時候,就常常被前端程式的開發環境給搞得暈頭轉向,如果只是做些畫面的...

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。

這個網站採用 Akismet 服務減少垃圾留言。進一步了解 Akismet 如何處理網站訪客的留言資料

專注於分享 WordPress 開發、接案技巧、專案管理等自由工作者必備知識與心得

© 2022 想點創意科技有限公司

Designed by Hend Design | 隱私權政策

訂閱電子報

Hi,我是 Oberon,我會固定在每週五早上發送接案心得以及與 WordPress 相關的電子報,同時也會分享一些實用的開發知識,讓你在 WordPress 的接案路上不孤單!