- はじめに
- トークンを取得する
- 1. Cisco Webex for Developers にアクセス・ログイン
- 2. トークンをコピーする
- Postman で実際に API を叩く
- 1. HTTP ヘッダーを入力する
- 2. 実際に API リファレンスを参照して API を叩いてみる
- 参考情報
はじめに
本ドキュメントでは Postman を利用して Webex API の挙動を確認する方法について説明します。Postman を利用することで実際に API でどのようなリクエストが送られて、どのようなレスポンスがサーバーから返ってきているかを簡単に確認することが出来ます。Postman のダウンロードは こちら のリンクをご利用ください。
Postman 利用方法は以下のリンクも併せてご確認ください。
【Top Out Human Capital 共催】Community Live : WebベースAPI基礎とPostmanの使い方
トークンを取得する
Webex API は REST API のため、API を叩く際には HTTP リクエストが利用されます。この際に API の利用の認証に利用されるのがトークンです。
今回のドキュメントでは、簡単に API の利用方法を確認するため、12 時間のみ有効な個人アカウントに紐づくトークンを利用します。
注意点
- 今回のドキュメントのトークンを利用することで行われるリクエストは、利用者自身が行うことになります。例えば、API を利用してユーザーA に対して 「Hello World!」というメッセージを送った場合には、トークン発行を行ったユーザーのアカウントからメッセージが送信されます。
- 上記のように本トークンには大きな権限が与えられるため、アプリケーション開発のための確認用途以外には利用されるべきではありません。
1. Cisco Webex for Developers にアクセス・ログイン
developer.webex.com にアクセスします。右上の "Log in" にて利用している Webex アカウントへのログインを行います。
2. トークンをコピーする
Your Personal Access Token の右のコピーボタンをクリックし、トークンをコピーします。
以上により、API を叩くための個人アカウントに紐づくトークンの発行が完了しました。
Postman で実際に API を叩く
Webex API は RESTful API のため、HTTP メソッドの GET, POST, PUT , DELETE リクエストを https://webexapis.com/v1/ に送信することで API を利用します。
今回は、Postman を利用して、実際に [GET List Rooms] をリクエストしてみます。
1. HTTP ヘッダーを入力する
API リファレンスガイドの List Rooms を確認します。このリクエストでは Webex でのスペース一覧を表示します。
GETメソッドで https://webexapis.com/v1/roomsへのリクエストを行います。Authorization ヘッダーには Bearer {取得したトークン} を入力します。
これらを踏まえて Postman に記載した情報が以下の例となります。
2. 実際に API リファレンスを参照して API を叩いてみる
API リファレンスガイドの List Rooms を確認して実際に HTTP リクエストを行います。
パラメーター情報は以下の通りです。
| 項目 | 内容 |
| teamId | string: 紐づくチームID |
| type | string: 表示するスペースの種類 |
| sortBy | string: 表示順序 (id, lastactivity, created) |
| max | number: 表示する最大スペース数（デフォルト 100） |
これらを以下のように Postman に入力することでリクエストを作成します。今回は sortByパラメタのみ利用しています。
Send をクリックしてリクエストを送信します。API から返されたレスポンスは Response タブにて確認可能です。
同様の流れにより API レファレンスに掲載された様々なリクエストを Postman にて確認することができます。具体的な例は以下の Postman コレクションも併せてご確認ください。
参考情報
