如果您的團隊中有一位知道如何使用 GraphQL API 的開發人員,則 Webex Events API 可以成為通往強大的事件和產品設置和管理自動化、協力廠商平台整合、強大的多事件資料儀表板等的閘道。
Webex 事件 API 可以做什麼
簡而言之,API 是開發人員可以用來從線上平台獲取數據或將數據放入在線平台中,在這種情況下是 Webex Events。
API 的功能可以簡化為四個基本概念:
-
建立以前不存在的內容,例如出席者、會話或整個活動。
-
更新 API 可用來創建的任何內容,以及更多一些東西。 例如,API 可用於建立新出席者,然後編輯該出席者的姓名、電子郵件、狀態、群組、電話號碼和社交帳戶。
-
閱讀有關 API 可用來創建或編輯的任何信息,以及其無法使用的某些內容。
-
刪除 API 可用來創建的任何內容,但某些例外情況除外。
閱讀本文的「與開發人員合作」一節時,請記住這些概念。
如何開始
1. 取得 API 的存取權
如果您是已啟Webex Suite用 Webex 事件的企業協議 (套件 EA) 客戶,則您將自動獲得 Webex 事件 API 的存取權! 對於所有其他客戶,請與您的 Webex Events 聯絡人或我們的支援團隊聯絡,以了解如何存取 API。
2. 建立 API 金鑰
現在,您需要創建一個新的 API 密鑰供您的開發人員使用。 當您存取 API 時,會將新標籤新增至 Webex 事件平台的「組織設定」頁面中。 以下是如何訪問新標籤並創建第一個密鑰:
請記住,只有組織管理員可以訪問 API 頁面。
-
在 Webex Events 平台的任何位置,按一下畫面右上角的個人檔案影像,然後從下拉式清單中選取「組織設定」。
-
在「組織設定」頁面上,按一下左側功能表中的 API 標籤。 這將您帶到 API 儀表板,您可以在其中查看 API 使用情況,導出使用日誌,管理金鑰,以及訪問我們的 API 文檔。
-
按一下「建立金鑰」。
-
在「創建新密鑰」模式中,輸入 API 金鑰的標籤,該標籤說明它將用於什麼。
-
API 版本下拉式清單將已選擇當前版本,因此只需單擊「保存」即可。 這會顯示 API 密鑰。
-
按一下金鑰旁邊的「複製」按鈕,然後將金鑰貼到安全的文件中,以確保密鑰永遠不會丟失。
警告!這是唯一可以訪問完整的 API 密鑰的時候。關閉模式後,完整鍵無法再讀取。
-
複製並儲存金鑰之後,按一下「關閉」 按鈕。
在大多數情況下,您只需要一個 API 密鑰。 但是,在您與多個團隊合作的情況下,您可能需要為每個團隊創建一個密鑰。 與您的開發人員討論您的特定使用案例,以找出最佳解決方案。
3. 邀請開發人員訪問 API
當您建立第一個 API 金鑰時,會在 Webex 事件平台中自動建立新的 API 小組。 讓開發人員使用 Webex 事件 API 的存取權限,就像邀請他們加入該 API 團隊一樣簡單。 按照管理團隊、成員和學分文章中的指示,了解如何進行操作。
請記住,API 沙箱是專為測試而設計的 Webex 事件平台的獨立版本。 這意味著 API 沙盒團隊的所有新成員都必須創建一個新的平台帳戶才能使用沙盒,即使他們已經擁有平台帳戶或使用其組織的 SSO 登錄。
您的 API 團隊中的人員無法像組織者一樣存取 Webex 活動平台的其他部分。 相反,API 團隊成員可以訪問 API「沙盒」,在這裡他們可以測試他們正在構建的內容,而不會影響現實世界數據。 如果您希望開發人員還能夠存取 Webex Events 平台中的部分或所有真實事件和應用程式,請邀請他們加入相關的非 API 團隊。
4. 善待您的開發人員
這是至關重要的,所以我們完成了一個整個步驟。😉
「羅馬並沒有在一天內建成的」,也不是一個很好的 API 集成。 成為開發人員的好朋友,並在期望他們提供整合之前,給他們充足的時間了解 Webex Events API 的速度。 他們會感激不受壓力
我們建議您至少在需要整合運作之前,與開發人員開始對話,不少於六個月。繼續閱讀以了解如何準備並進行這些對話。
與開發人員合作
邀請開發人員加入 Webex Events 沙盒團隊後,您的第一個問題可能是:「建置整合需要多長時間?」回答這個問題取決於許多因素,包括您正在與多少開發人員合作、他們在整合上工作的時間、整合的複雜程度等等。
只有您的開發人員才能告訴您整合的設置需要多長時間,只有幾個重要步驟後才能告訴您:
-
首先,請閱讀以下各節以了解 API 可以做什麼。 這將幫助您了解什麼是可能的,以便您可以清楚地與開發人員溝通您的需求。
-
與您的開發人員會面,與他們分享我們的 API 文檔,並討論您想要的內容。 他們將能夠對他們可以和不能為您做什麼提供基本的反饋。 但是,除非熟悉 Webex 事件 API,他們將無法為您提供特定的時間表。
-
讓您的開發人員時間熟悉 API。 讓自己可以回答有關事件、資料、Webex 事件平台和其他任何內容的概念或實際問題。
API 可以做什麼
API 具有兩個基本功能:
-
讀取-從 Webex 事件取得資料,以便您可以檢查資料或將其拉入其他系統中。
-
更新-將資料放入 Webex Events,以從其他平台建立新項目或同步資料 (例如與會者)。 在 Webex 事件平台中變更某些內容的任何內容都是更新。
團隊和組織
-
建立、更新、閱讀和刪除團隊和團隊成員
大事記
-
更新、克隆和閱讀。 無法使用 API 建立或刪除事件。
出席者
-
建立、更新、閱讀、指派給會話、指派給群組,以及刪除社交帳戶資訊(電話號碼、社交帳戶代理等)。 不能刪除與會者,但可以封鎖他們。
問題
-
建立、更新、閱讀和刪除
提示:在 API 中,問題稱為「自定義字段」
群組
-
建立、更新、閱讀和刪除獨家和非獨家群組
會議
-
建立、更新、閱讀和刪除
位置
-
建立、更新、閱讀和刪除
提示:在 API 中,位置稱為「區域」。
品牌應用程式
-
閱讀品牌應用程式名稱、狀態以及指派事件的名稱
活動應用程式
-
閱讀基本資訊、外觀和Web App設定以及視訊中心錄製資訊
-
建立、更新、閱讀和刪除以下 Event App 功能及其項目 (如適用):
-
議程
-
贊助商
-
喇叭
-
參展商
-
直播
-
出席者
-
自訂清單
-
單一項目
-
網頁連結
-
網頁列表
-
我的二維碼
-
請記住,您必須手動添加和設置上面未列出的任何事件應用程序功能。
提示:在 API 中,功能稱為「組件」。
註冊
-
閱讀基本資訊、外觀和設定資訊,包括結帳設定
-
創建,閱讀,更新和刪除門票,表單,問題,促銷代碼
-
建立、讀取和更新訂單
-
發送訂單和機票確認電子郵件
-
將支票或發票訂單標記為已付
-
更新訂單採購者資訊
-
取消及退款機票
-
創建,閱讀,更新,刪除,暫停和恢復促銷代碼
-
建立、閱讀、更新和刪除稅金
提示:在 API 中,問題稱為「自定義字段」。
現場
-
閱讀和更新基礎知識和現場應用程式資訊
潛在客戶檢索和實時顯示
-
閱讀產品是否有效還是在活動中發佈
你需要知道的事
-
API 無法用於建立活動或啟動活動中的任何產品,例如「活動應用程式」和「現場」。 開發人員可以使用 API 修改事件之前,您必須啟動您打算使用的每個產品,並為每個產品填寫必要的基本信息。
-
我們偶爾會發布新版本的 API,並提供改進和修復。 我們將繼續支持舊版本足夠長,讓每個人都可以轉換到新版本。 我們會發送有關新版本、即將到來的舊版本停用日期和官方停用的電子郵件更新。
-
API 請求被計量並受到限制,以防止濫用。
-
套裝客戶也支援社群。