Webex イベント API を使い始めましょう

チームにGraphQL APIの使用方法を知っている開発者がいる場合、Webex Events APIは、強力なイベントと製品のセットアップと管理の自動化、サードパーティのプラットフォーム統合、強力なマルチイベントデータダッシュボードなどへのゲートウェイとなる可能性があります。

Webex イベント API でできること

簡単に言えば、APIは、開発者がオンラインプラットフォーム（この場合はWebex Events）からデータを取得したり、データを入力したりするために使用できるプログラミングインターフェイスです。

APIの機能は、次の4つの基本概念に簡略化できます。

参加者、セッション、イベント全体など、以前には存在しなかったものを作成してください。
APIを使用して作成できるものは何でも更新してください。他にもいくつか更新してください。たとえば、このAPIを使用して新しい参加者を作成し、その参加者の名前、電子メール、ステータス、グループ、電話番号、ソーシャルアカウントを編集できます。
APIで作成または編集できるものや、できないことについての情報を読んでください。
いくつかの例外を除いて、APIを使用して作成できるものはすべて削除してください。

この記事の「開発者との協力」セクションを読むときは、これらの概念を念頭に置いてください。

始める方法

1. APIにアクセスしてください

すでにWebex Webex Suite Eventsを有効にしているエンタープライズ契約（スイートEA）のお客様であれば、自動的に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 キーを作成すると、新しい API チームが Webex Events プラットフォームに自動的に作成されます。開発者にWebex Events APIを試すためのアクセス権を与えるのは、そのAPIチームに開発者を招待するのと同じくらい簡単です。チーム、メンバー、クレジットの管理に関する記事の指示に従って、方法を確認してください。

API サンドボックスは、テスト専用に作られた Webex Events プラットフォームの別のバージョンであることを覚えておいてください。つまり、API Sandboxチームの新しいメンバーは全員、すでにプラットフォームアカウントを持っているか、組織のSSOでログインしている場合でも、サンドボックスを使用するには新しいプラットフォームアカウントを作成する必要があります。

API チームのメンバーは、主催者のように他の Webex Events プラットフォームにアクセスできません。代わりに、APIチームのメンバーはAPIの「サンドボックス」にアクセスして、実際のデータに影響を与えずに構築中のものをテストできます。 Webex Events プラットフォームにある実際のイベントやアプリの一部またはすべてに開発者にもアクセスさせたい場合は、関連する API 以外のチームに招待してください。

4. 開発者に親切にしてください

これは非常に重要なので、私たちはそれを一歩進めました。😉

「ローマは一日で成り立たなかった」し、APIの統合も良好ではありませんでした。開発者の良き友人になり、インテグレーションの提供を期待する前に、Webex Events APIに慣れるための十分な時間を与えてください。彼らはプレッシャーがかからないことに感謝するでしょう。

少なくとも、インテグレーションが機能するようになる6か月前までに、開発者と会話を始めることをお勧めします。読み続けて、準備の仕方や会話の仕方を学んでください。

開発者との協力

Webex Events Sandbox チームに開発者を招待した後、最初に聞かれる質問の 1 つは、「インテグレーションの構築にはどれくらいの時間がかかりますか？」この質問に答えるかどうかは、一緒に仕事をしている開発者の数、彼らが統合に取り組むのにどれくらいの時間が必要か、統合がどれほど複雑かなど、多くの要因によって異なります。

インテグレーションの設定にどれくらいの時間がかかるかは、いくつかの重要なステップを経て初めて教えてくれます。

まず、以下のセクションを読んで、APIで何ができるかを学びましょう。これにより、何が可能かを理解し、開発者にニーズを明確に伝えることができます。
開発者と会って、APIドキュメントを共有して、何が欲しいか話し合ってください。彼らはあなたのためにできることとできないことについて、基本的なフィードバックをすることができます。ただし、Webex Events APIに慣れるまで、特定のタイムラインを提供することはできません。
開発者にAPIに慣れる時間を与えてください。イベント、データ、Webex Events プラットフォームなどに関する概念的または実践的な質問に答えられるようにしましょう。

APIでできること

APIには2つの基本機能があります。

読み取り-Webex Eventsからデータを取得して、調べたり、別のシステムに取り込んだりできます。
更新-Webex Eventsにデータを入力して、新しいアイテムを作成したり、別のプラットフォームの出席者などのデータを同期したりできます。 Webex Events プラットフォームで何かを変えるものはすべてアップデートです。

チームと組織

チームとチームメンバーを作成、更新、読み取り、削除する

イベント

更新、クローン、読み取り。 APIではイベントを作成したり削除したりすることはできません。

出席者

作成、更新、読み取り、セッションへの割り当て、グループへの割り当て、ソーシャルアカウント情報（電話番号、ソーシャルアカウントのハンドルなど）の削除を行います。出席者をブロックすることはできますが、削除することはできません。

質問

作成、更新、読み取り、削除

ヒント:APIでは、質問は「カスタムフィールド」と呼ばれます

グループ

排他的グループと非独占的グループの両方を作成、更新、読み取り、削除します

セッション

作成、更新、読み取り、削除

場所

作成、更新、読み取り、削除

ヒント:APIでは、場所は「地域」と呼ばれます。

ブランドアプリ

ブランドアプリの名前、ステータス、割り当てられたイベントの名前を読んでください

イベントアプリ

基本情報、外観、Web App設定に加えて、ビデオセンターの録画情報を読んでください
該当する場合、イベントアプリの次の機能とそのアイテムを作成、更新、読み取り、削除してください。
- アジェンダ
- スポンサー
- スピーカー
- 出展者
- ライブストリーム
- 出席者
- カスタムリスト
- 単一アイテム
- ウェブリンク
- ウェブリスト
- 私のQRコード

上記に記載されていないイベントアプリの機能は手動で追加して設定する必要があることを覚えておいてください。

ヒント:APIでは、機能は「コンポーネント」と呼ばれます。

登録

チェックアウト設定を含む、基本情報、外観、設定情報を読んでください
チケット、フォーム、質問、プロモーションコードを作成、読み取り、更新、削除する
注文の作成、読み取り、更新を行います
注文とチケットの確認メールを送る
小切手または請求書の注文を支払済みとしてマークします
注文購入者情報を更新してください
チケットのキャンセルと払い戻し
プロモーションコードを作成、読み取り、更新、削除、一時停止、再開します
税の作成、読み取り、更新、削除を行います

ヒント:APIでは、質問は「カスタムフィールド」と呼ばれます。

オンサイト

基本情報とオンサイトアプリ情報を読んで更新してください

リード検索とライブディスプレイ

その商品が発売中なのか、イベントで公開されているのかを読んでください

知っておくべきこと

APIを使用してイベントを作成したり、イベントアプリやオンサイトなどのイベント内の製品をアクティブ化したりすることはできません。開発者がAPIを使用してイベントを変更する前に、使用する各製品をアクティベートし、それぞれに必要な基本情報を入力する必要があります。
改良や修正を加えた新しいバージョンのAPIを時折リリースします。私たちは、誰もが新しいバージョンに移行できるまで、古いバージョンをサポートし続けます。新しいバージョン、今後の旧バージョンの廃止日、正式な廃止予定についての最新情報をメールで送信します。
APIリクエストは、悪用を防ぐために従量制で制限されています。
Suiteのお客様にはコミュニティもサポートされています。

Cisco AI Assistant

コメントありがとうございます。