この記事は、機械翻訳を使用して英語から翻訳されました。
チーム内に GraphQL API の使い方を知っている開発者がいる場合、 Webex Events API は、強力なイベントおよび製品のセットアップと管理の自動化、サードパーティ プラットフォームの統合、強力なマルチイベント データ ダッシュボードなどへのゲートウェイとなる可能性があります。
Webex EventsAPI でできること
簡単に言えば、API は、開発者がオンライン プラットフォーム (この場合はWebex Events)からデータを取得したり、オンライン プラットフォームにデータを保存したりするために使用できるプログラミング インターフェイスです。
API の機能は、次の 4 つの基本概念に簡略化できます。
出席者、セッション、イベント全体など、これまで存在しなかったものを作成します。
API を使用して作成できるものすべて、およびその他いくつかのものを更新します。たとえば、API を使用して新しい出席者を作成し、その出席者の名前、メール アドレス、ステータス、グループ、電話番号、ソーシャル アカウントを編集できます。
API を使用して作成または編集できるもの、および API を使用して作成または編集できないものに関する情報をお読みください。
いくつかの例外を除き、API を使用して作成できるものはすべて削除します。
この記事の「開発者との連携」セクションを読む際は、これらの概念を念頭に置いてください。
どうやって始めるのか
1. APIにアクセスする
Webex Suite Enterprise Agreement (Suite EA) のお客様で、すでにWebex Eventsが有効になっている場合は、 Webex Events API に自動的にアクセスできます。その他のすべてのお客様の場合は、 Webex Events の担当者またはサポート チームに問い合わせて、API へのアクセス方法を確認してください。
2. APIキーを作成する
次に、開発者が使用するための新しい API キーを作成する必要があります。API にアクセスできると、 Webex Eventsプラットフォームの [組織設定] ページに新しいタブが追加されます。新しいタブにアクセスして最初のキーを作成する方法は次のとおりです。
💡 API ページにアクセスできるのは組織管理者のみであることに留意してください。
Webex Eventsプラットフォームのどこからでも、画面の右上隅にあるプロフィール画像をクリックし、ドロップダウンから[組織の設定]を選択します。
組織設定ページで、左側のメニューのAPIタブをクリックします。これにより、API ダッシュボードに移動し、API の使用状況を確認したり、使用ログをエクスポートしたり、キーを管理したり、API ドキュメントにアクセスしたりすることができます。
「キーの作成」をクリックします。
「新しいキーの作成」モーダルで、API キーの用途を説明するラベルを入力します。
API バージョンのドロップダウンにはすでに現在のバージョンが選択されているので、 [保存] をクリックするだけです。これにより、API キーが表示されます。
キーの横にある[コピー]ボタンをクリックし、キーを安全なドキュメントに貼り付けて、紛失しないようにします。
⚠️警告! 完全な API キーにアクセスできるのはこのときだけです。モーダルを閉じると、完全なキーを再度読み取ることはできません。
キーをコピーして保存したら、 「閉じる」ボタンをクリックします。
ほとんどの場合、必要な API キーは 1 つだけです。ただし、複数のチームで作業している場合は、チームごとにキーを作成する必要があります。最適なソリューションを見つけるには、特定のユースケースについて開発者と話し合ってください。
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機能とその項目を作成、更新、読み取り、および削除します。
議題
スポンサー
スピーカー
出展者
ライブストリーム
出席者
カスタムリスト
単品
ウェブリンク
ウェブリスト
私のQRコード
💡 上記に記載されていないEvent Appの機能は手動で追加および構成する必要があることに注意してください。
ヒント: API では、機能は「コンポーネント」と呼ばれます。
登録
チェックアウト設定を含む基本、外観、設定情報を読む
チケット、フォーム、質問、プロモーションコードの作成、読み取り、更新、削除
注文の作成、読み取り、更新
注文とチケットの確認メールを送信する
小切手または請求書の注文を支払済みとしてマークする
注文購入者情報を更新する
チケットのキャンセルと払い戻し
プロモーション コードの作成、読み取り、更新、削除、一時停止、再開
税金の作成、読み取り、更新、削除
ヒント: API では、質問は「カスタム フィールド」と呼ばれます。
Onsiteで
基本情報とOnsite Appの情報を読んで更新する
Lead RetrievalとLive Display
製品がイベントでアクティブまたは公開されているかどうかを確認します
知っておくべきこと
改善や修正を加えた新しいバージョンの API を随時リリースします。古いバージョンは、すべてのユーザーが新しいバージョンに移行できるまで引き続きサポートします。新しいバージョン、古いバージョンの廃止予定日、および正式な廃止に関する更新情報をメールでお送りします。
API リクエストは、不正使用を防ぐために計測され、制限されています。
Suite のお客様にはコミュニティもサポートされます。