跳至主要內容
全部系列整合與合作
Webex Events API 入門
Webex Events API 入門

API 的用途以及如何開始

Daniel Murphey avatar
作者：Daniel Murphey
4 個月前已更新

這篇文章是使用機器翻譯從英文翻譯而來的。

如果您的團隊中有一位了解如何使用 GraphQL API 的開發人員，Webex Events API 可以成為您通往強大的事件和產品設置和管理自動化、第三方平台整合、強大的多事件資料儀表板等的門戶。

Webex Events API 的功能

簡而言之，API 是一種程式設計接口，開發人員可以使用它從線上平台（在本例中Webex Events）獲取資料或將資料放入其中。

API 的功能可以簡化為四個基本概念：

  • 創建以前不存在的內容，例如與會者、會議或整個活動。

  • 更新API 可用於建立的任何內容，以及更多內容。例如，API 可用於建立新的與會者，然後編輯該與會者的姓名、電子郵件、狀態、群組、電話號碼和社交帳戶。

  • 閱讀有關 API 可用於建立或編輯的任何內容以及它不能用於建立或編輯的內容的資訊。

  • 刪除API 可用於建立的任何內容，但有一些例外。

在閱讀本文的「與開發人員合作」部分時，請記住這些概念。

如何開始

1. 取得API存取權限

如果您是已啟動Webex Events的 Webex Suite Enterprise 協定 (Suite EA) 客戶，您將自動獲得對Webex Events API 的存取權限！對於所有其他客戶，請與您的Webex Events聯絡人或我們的支援團隊聯繫，以了解如何存取 API。

2. 建立 API 金鑰

現在您需要建立一個新的 API 金鑰供開發人員使用。當您有權存取 API 時， Webex Events平台中的「組織設定」頁面中會新增一個新分頁。以下是存取新分頁並建立第一個金鑰的方法：

💡 請記住，只有組織管理員才能存取 API 頁面。

  1. 從Webex Events平台中的任何位置，點擊螢幕右上角的個人資料圖像，然後從下拉清單中選擇組織設定。

  2. 在組織設定頁面上，按一下左側選單中的API標籤。這將帶您進入 API 儀表板，您可以在其中查看 API 使用情況、匯出使用日誌、管理金鑰以及存取我們的 API 文件。

  3. 點選建立金鑰。

  4. 在「建立新金鑰」模式中，輸入 API 金鑰的標籤，說明其用途。

  5. API 版本下拉清單已選擇目前版本，因此只需按一下「儲存」即可。這會顯示 API 金鑰。

  6. 點擊金鑰旁邊的「複製」按鈕，然後將金鑰貼到安全文件中，以確保它永遠不會遺失。

    ⚠️警告！這是唯一一次可以存取完整的 API 金鑰。關閉模式後，將無法再次讀取完整密鑰。

  7. 複製並儲存金鑰後，按一下“關閉”按鈕。

大多數情況下，您只需要一個 API 金鑰。但是，在與多個團隊合作的情況下，您可能需要為每個團隊建立一個金鑰。與您的開發人員討論您的特定用例，以找出最佳解決方案。

3.邀請開發者接上API

當您建立第一個 API 金鑰時，會在Webex Events平台中自動建立一個新的 API 團隊。為您的開發人員提供試用Webex Events API 的權限就像邀請他們加入該 API 團隊一樣簡單。請按照我們有關管理團隊、成員和積分的文章中的說明來了解具體操作方法。

💡 請記住，API 沙箱是專門用於測試的Webex Events平台的單獨版本。這意味著 API 沙箱團隊的所有新成員都必須建立新的平台帳戶才能使用沙箱，即使他們已經擁有平台帳戶或使用其組織的 SSO 登入也是如此。

API 團隊中的人員無法像組織者一樣存取Webex Events平台的其餘部分。相反，API 團隊成員可以存取 API“沙箱”，在其中測試他們正在建立的內容，而不會影響實際資料。如果您希望開發人員也能夠存取Webex Events平台中的部分或全部真實事件和應用程序，請邀請他們加入相關的非 API 團隊。

4. 準備活動

由於 API 無法啟動活動中的任何產品（例如Event App和Onsite），因此您必須啟動要在活動中使用的每個產品，並填寫基本的必需資訊。

與開發人員合作

對您來說，與開發人員進行清晰的溝通非常重要，以便他們可以建立您需要的內容。這意味著您需要了解 API 可以存取Webex Events平台的哪些部分。繼續閱讀以準確了解 API 可以存取和控制的內容，以及一些幫助您與開發人員「說相同的語言」的提示。

當您熟悉基本功能後，您可以開始與開發人員討論使用 API 建置工具和自動化。

團隊和組織

  • 建立、更新、讀取和刪除團隊和團隊成員

活動

  • 建立、更新、克隆和讀取。活動無法刪除。

出席者

  • 建立、更新、讀取、分配給會話、分配給群組以及刪除社交帳戶資訊（電話號碼、社交帳戶句柄等）。無法刪除與會者，但可以阻止他們。

問題

  • 建立、更新、讀取和刪除

提示：在 API 中，問題稱為“自訂欄位”

團體

  • 建立、更新、讀取和刪除獨佔和非獨佔群組

會議

  • 建立、更新、讀取和刪除

地點

  • 建立、更新、讀取和刪除

提示：在 API 中，位置稱為「區域」。

Branded Apps

  • 讀取Branded App名稱、狀態和分配的事件的名稱

Event App

  • 閱讀基礎知識、外觀和 Web 應用程式設定以及Video Center錄製訊息

  • 建立、更新、讀取和刪除以下Event App功能及其項目（如果適用）：

    • 議程

    • 贊助商

    • 揚聲器

    • 參展商

    • 現場直播

    • 出席者

    • 自訂列表

    • 單品

    • 網站連結

    • 網頁列表

    • 我的二維碼

💡 請記住，您必須手動新增和配置上面未列出的任何Event App功能。

提示：在 API 中，功能稱為「元件」。

登記

  • 閱讀基礎知識、外觀和設定訊息，包括結帳設置

  • 建立、讀取、更新和刪除門票、表格、問題、促銷代碼

  • 建立、讀取和更新訂單

  • 發送訂單和門票確認電子郵件

  • 將支票或發票訂單標記為已付款

  • 更新訂單購買者訊息

  • 取消並退款機票

  • 建立、讀取、更新、刪除、暫停和恢復促銷代碼

  • 建立、讀取、更新和刪除稅費

提示：在 API 中，問題稱為「自訂欄位」。

Onsite

  • 閱讀並更新基礎知識和Onsite App信息

Lead Retrieval和Live Display

  • 查看產品是否處於活動狀態或已在活動中發布

要知道的事情

  • 我們偶爾會發布帶有改進和修復的 API 新版本。我們將繼續支援舊版本足夠長的時間，以便每個人都能過渡到新版本。我們將發送有關新版本、即將到來的舊版本棄用日期和官方棄用的電子郵件更新。

  • API 請求受到計量和限制，以防止濫用。

  • Suite 客戶也支援社群。

是否回答了您的問題？