クイックスタートガイド - Postmanを使用してSplashtopオープンAPIを照会する

この記事ではSplashtopオープンAPI にリクエストを送信し、基本情報とチームコンピュータのリストを
取得するためのPostmanのセットアップについてご案内します。

必要要件:

Postmanのセットアップ:

1.Postmanにサインインしてワークスペースを作成します。

Img1_ja.png

2. 次のステップで「空のワークスペース」を選択し、「次へ」をクリックします。

Img2_ja.png

3. ワークスペースに名前を付け、「作成」をクリックします。この例では、SplashtopAPI_testという
名前が付けられています。

Img3_ja.png

4. メニューバーで「コレクション」⇒「コレクションの作成」をクリックします。コレクションに必要な名前を付けます。この例ではコレクションの名前はGetCollectionとします:

Img4_ja.png

Postmanの基本的なセットアップが完了し、リクエストの作成を開始できます。

 

基本情報の取得リクエスト:

基本情報リクエストでは表示名、電子メール、2段階認証、タイムゾーン、APIの範囲、チームID を
取得します。

1. 「リクエストの追加」をクリックし、必要に応じてリクエストの名前を変更します。
この例では、リクエストの名前は Get_Basic_info としています:

Img5_ja.png

2. GETフィールドにAPI URLを挿入します:

https://webapi.splashtop.com/api/open/v1/users/basic_info

詳細についてはSplashtop Open API Referenceをご確認ください。

Img6_ja.png

3. 「認証」をクリックし、タイプをBearer Tokenに選択して、 Splashtop Web管理コンソールからAPIトークンを貼り付けます。(リンク:https://my.splashtop.com/account_info/#apis_tab)

Splashtop APIトークンのセットアップの詳細についてはSplashtopオープンAPIの記事をご確認ください。

Img7_ja.png

 

4. 「保存して送信」をクリックします。基本情報と取得結果、ステータスが応答エリアにリストされます。

Img8_ja.png

5.次のリクエストのために「stb_team_id」を保存します。この例では、チーム IDは 1169059です。
リクエスト結果から自分のチームIDを取得してください。

Img9_ja.png

 

コンピュータリストリクエストを取得する

パラメーターを追加せずにコンピュータのリストを取得すると、APIはすべてのコンピュータからのデータを返します。

1.前の手順でチームIDを取得します。この例では、チームIDは169059です。

2. コレクション名の横にある 3点ドットをクリックし、「リクエストの追加」をクリックして、
新しいリクエストに Get_Computer_list という名前を付けます。

Img10_ja.png

3.コンピューターリストAPIリンクを挿入し、{team_id}を前のリクエスト結果のチームIDに置き換えます。https://webapi.splashtop.com/api/open/v1/teams/{team_id}/computers

この例では、リンクは次のとおりです。 

 https://webapi.splashtop.com/api/open/v1/teams/1169059/computers

Img11_ja.png

4. 「認証」をクリックして「Bearer Token」を選択し、トークンが正しく表示されていることを
再度確認します。

Img12_ja.png

5. 「保存して実行」をクリックします。コンピュータリストが応答領域に表示されます。

Img13_ja.png

API 呼び出しの機能と使用方法の詳細については Splashtop open API referenceをご確認ください

 

0人中0人がこの記事が役に立ったと言っています