AirWatch API Explorer の使用方法

AirWatch は一連の RESTful API を提供しています。この API を使用して既存の IT インフラストラクチャやサード パーティ製アプリケーションと統合することにより、外部のプログラムから AirWatch の主要機能を利用することができるようになります。AirWatch REST API はシンプルな REST 形式のソフトウェア アーキテクチャを採用しつつ、組織グループ、コンソール管理、モバイル アプリ、モバイル デバイス、E メール、加入ユーザー、プロファイル、スマート グループ、ユーザー グループ管理など、現時点で多岐にわたる機能をサポートしています。

このページの受信登録 (SUBSCRIBE) を行うと、AirWatch API Explorer に関する最新情報がいち早くお手元に届きます。

[00:09]
AirWatch 9.2 では AirWatch API ドキュメントに素晴らしい変更が加えられました。ここでは、かつてないほど簡単に操作でき、AirWatch API の理解に役立つ、この新しい API フレームワークについて説明します。
 
[00:23]
はじめに、AirWatch API エンドポイント URL の末尾に「/help」を付けた URL にアクセスします。AirWatch REST API エンドポイントを確認する場合は、AirWatch コンソールで グループと設定 > すべての設定 > システム > 高度な設定 > サイト URL と進みます。ここに貴社環境の AirWatch REST API URL が表示されています。
 
[00:52]
VMware AirWatch API Explorer 画面に戻ります。概要ページには「Getting Started with the AirWatch API」ガイドが表示されています。このページは、まだ AirWatch API をよく知らないユーザーに役立つ情報を提供します。また、変更履歴、認証やサーバ要件などの API 利用時の重要な考慮事項、HTTP リクエスト ヘッダやレスポンス ヘッダに関する一般的な情報なども掲載されています。
 
[01:17]
また、このガイドには初期セットアップ ページも含まれています。このページは、貴社環境の AirWatch REST API をセットアップ/構成するためのステップ バイ ステップ ガイドです。
 
[01:28]
Apis タブには利用可能な AirWatch API のリストが、エンドポイント/バージョン別に記載されています。目的のリンクをクリックするだけで、そのセクションのすべての API リファレンスが表示されます。
 
[01:41]
概要ページには、その API 群を使用してどのようなアクションを実行できるか、その API 群を使用するにあたってどのような要件が必要かが簡単に説明されています。
 
[01:53]
API Reference タブを選択すると、そのセクションの全 API のリストが表示されます。各カテゴリをクリックすると、そのカテゴリに含まれる API エンドポイントのリストが展開されます。各エンドポイントをクリックすると、詳細な API ドキュメントが表示されます。
 
[02:07]
ここには該当エンドポイントの開発者向けメモと、正常終了した場合に返されるレスポンスの情報が記載されています。
 
[02:15]
このエンドポイントへのリクエストに対する出力例を表示することも、出力データのデータ モデルを表示することもできます。
 
[02:23]
また、必要に応じて、レスポンスの Content Type を JSON と XML とで切り替えることができます。Content Type を変更すると、それに合わせてドキュメントの表示も変わります。
 
[02:35]
このエンドポイントへのリクエストに使用するパラメータのリストも掲載されています。各パラメータには、それが必須かオプションか、データ型は何か、もあわせて記載されています。
 
[02:47]
ドキュメントの末尾には、この API 呼び出しで返される可能性がある、その他のレスポンス メッセージのリストが掲載されています。ここでは、受け取る可能性があるレスポンス メッセージごとに、ステータス コード、理由、関連するデータ モデルが列挙されています。
 
[03:04]
ページの先頭では、フィルタ検索バーを使用して特定の API を検索することができます。例えば代理加入 (staging) の API を使用したい場合には、検索バーに「staging」と入力すると、このキーワードに該当する API のリストが表示されます。
 
[03:21]
同様に API Explorer の最初のページからも検索機能を利用できます。特定のエンドポイントをどのセクションで探せばよいかわからない場合は、このページでそのエンドポイントを入力すると、該当する API のリストが表示されます。リストの API をクリックすると、目的のページに移動し、通常の場合と同じようにその API ドキュメントが表示されます。
 
[03:41]
新しくなった AirWatch REST API ヘルプ ページをぜひご活用ください。Happy Coding!

免責事項:これは英文の記事「How to use VMware AirWatch API Explorer」の日本語訳です。記事はベストエフォートで翻訳を進めているため、ローカライズ化コンテンツは最新情報ではない可能性があります。最新情報は英語版の記事で参照してください。

Have more questions? Submit a request

1 Comments

Article is closed for comments.