この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
CMX モビリティ サービスを使用することで、開発者は Wi-Fi とデバイス MAC アドレスによってデバイスのロケーションを利用できるようになります。クーポンやプロモーションなどのプッシュ通知をデバイスに提供することで、カスタマー エクスペリエンスの向上が期待できます。さらに、様々なクライアント ロケーション ベースのサービス ソリューションを開発し、エンド デバイス ユーザや施設内のオペレータが利用できる数多くのアプリケーションを提供することもできます。
このソリューションは、Wi-Fi フィールドで動作するモバイル デバイスを検出、接続、およびエンゲージするためのモバイル ソフトウェア ソリューションからなる画期的なスイートです。各モバイル ソフトウェア サービスが連携して、クライアントとそのエンド ユーザが現実の様々な状況下で便利に利用できるように設定できる、包括的なソリューションを形成します。
CMX モビリティ サービス Restful API により、これらを様々な言語、プラットフォーム、フレームワークにわたって使用できます。API を介して、Wi-Fi ネットワークから収集されたリアルタイムのインテリジェンスを活用したアプリケーション ソリューションを開発することで、ロケーション、温度、ユーザのアベイラビリティ、モバイル デバイスのアセットなどのリアルタイムのコンテキスト情報を通じて、ユーザやユーザのデバイスとのより効果的な対話を実現できます。
このガイドでは、CMX モビリティ サービス Restful API について説明します。Cisco CMX モビリティ アプリケーションの詳細については、http://www.cisco.com/c/en/us/td/docs/wireless/mse/8-0/CMX-Connect-and-Engage-Mobile-SDK/guide/Cisco-CMX-ConnectEngage-Mobile-SDK-Config-Guide.htmlを参照してください。
(注) | CMX モビリティ サービスのすべての機能およびガイドに関する情報は、Cisco DevNet サイトで閲覧できます。 |
Cisco Connect Mobile Experiences(Cisco CMX)が提供する簡素化された Representational State Transfer(REST)API は、様々な方法で使用できます。RESTful API には次の利点があります。
ステートレス REST アーキテクチャに基づいています。
情報は十分に理解されている HTTP/HTTPS プロトコル経由で配信されます。
簡素化された設計で、リソース URI を簡単に理解することができます。通常、リソース URI の内容は一目瞭然です。
標準化されたライブラリにより、ユーザが要求するフォーマットで自動的に応答を送信してコンテンツをネゴシエーションできます。
データ モデルの簡素化、古い拡張性のない API の廃止、階層依存性の排除といった機能向上に取り組むことができるようにします。
REST API では次の HTTP メソッドを使用します。
GET:リソースの表現を取得する HTTP メソッド。
PUT:URI でエンティティを保管する HTTP メソッド。このメソッドは、新しいエンティティの作成や既存のエンティティの更新に役立ちます。
POST:URI にあるリソースを要求し、指定されたエンティティで何らかのアクションを実行する HTTP メソッド。
DELETE:リソースの削除を要求する HTTP メソッド。
Cisco CMX では、REST API に固有の更新済みドキュメントを提供しています。これらの資料に、REST API クエリーの名前、メソッド、構造が説明されています。REST API ドキュメントについての詳細は、http://mse-ip-address/apidocs/を参照してください。
REST API ドキュメントは、特定の機能に基づく 5 つの論理カテゴリに分類されています。API の分類は次のとおりです。
Cisco MSE にクエリーを送信するには、ユーザ名とパスワードが必要です。これらのクレデンシャルは、Base64 でエンコードされた文字列を作成するために必要となります。認証に成功すると、要求が HTTP メソッド(GET、PUT、POST、DELETE)によって送信されます。
REST API のワークフローは次のとおりです。
要求を開始する前に、クライアント側から Authorization ヘッダーを使用して認証が送信されます。
ユーザ名とパスワードのクレデンシャルを結合して、文字列「username:password」を作成します。
作成された文字列リテラルを Base64 でエンコードします。
エンコードされた文字列の前に、認証方式(スペースおよび「Basic」という文字列)を追加します。
たとえば、ユーザ エージェントがユーザ名として「MyUsername」、パスワードとして「MyPassword」を使用している場合、次のヘッダーが作成されます。
Authorization: Basic QxhZGluOnNlc2FtIG9wZW4=
認証が宛先のルート URL(例:https://<mseip>/api/contextaware)に送信されます。
以下に、Base64 でエンコードされた認証文字列を作成する Python 2.7.x の例を示します。
import urllib2 | mse_user = 'username' ##MSE Username mse_pass = ;password' ##MSE Password password_manager = urllib2.HTTPPasswordMgrWithDefaultrealm() password_manager.add_password( None, 'https://ip-address-of-mse' , mse_user, mse_pass ##IP Address or resolvable hostname ) auth_handler = urllib2.HTTPBasicAuthHandler(password_manager) opener = urllib2.build_opener(auth_handler) urllib2.install_opener(opener)
REST API と対話するには、次の 3 つの方法があります。
Cisco CMX に同梱されている REST API ドキュメントには、ブラウザからアクセスできます。Cisco CMX REST API ドキュメントのページは、サーバ上でホストされています。REST API のほとんどには、[Try It] 機能があります。
Cisco CMX に対する API コールおよびクエリーの構造をテストするには、最新バージョンの Web ブラウザ(Google Chrome、Mozilla Firefox)対応の REST クライアント プラグインを使用してください。たとえば、Advanced REST Client、Postman、REST Client などのプラグインを使用します。使用する REST クライアントは自由に選択できます。
次の例では、Chrome の Advanced REST Client プラグインを使用しています。
(注) | REST クライアントの使用方法の詳細は、選択した REST クライアントのプラグインおよびアプリケーションに関する手順を参照してください。 |
API コールの構造をテストするには、Python プログラミング言語を使用します。Python は、データセンター環境でのリソースの設定および操作に広範に使用されている単純なプログラミング言語です。Python 2.7. と Python 3.4.x の両方が使用されます。どちらの Python バージョンが使用されているかは、コード内のコメントで示されます。
(注) | 以下の例は単純なものなので、フォーマット設定やその他の機能は実装されていません。 |
ヒント | CMX REST API にアクセスするアプリケーションの作成について最良のサポートを得るには、Cisco Devnet に参加してください。詳細については、https://developer.cisco.com/site/devnet/home/index.gspを参照してください。 |
ヒント | Cisco CMX REST API にアクセスするアプリケーションを作成する際に最良のサポートを得るには、Cisco Devnet に参加することをお勧めします。詳細については、https://developer.cisco.com/site/devnet/home/index.gspを参照してください。 |
204 を返します。コンテンツはありません。
Cisco MSE では、すべてのクライアントのすべてのアクティビティについて、リアルタイム ストリームを宛先に送信できます。これらの通知はロケーション更新イベントのスーパーセットです。通知機能を有効にするには、PUT API および GET API を使用します。
204 を返します。コンテンツはありません。
『Cisco Connected Mobile Experiences REST API Guide, Release 10.2』に、Cisco CMX ソリューションのすべての REST API が記載されています。詳細については、https://www.cisco.com/c/en/us/td/docs/wireless/mse/10-2/api/b_cmx_102_api_reference.htmlを参照してください。