Mobility Services Engine (MSE) REST API

This self-paced learning lab provides an introduction taking advantage of the real time location based functionality provided by Cisco's Connected Mobile Experience (CMX) through Cisco's Mobility Services Engine (MSE). This is done using RESTful APIs provided by the Mobility Services Engine (MSE), which allows developers to access the backbone of the Connected Mobile Experience and easily create applications that can track WiFi clients.

The following learning lab is designed to introduce the technology, showing some of the basic functionality that can be leveraged. We invite you to then expand on what is introduced here and further developer your own applications.

Objective

Completion time: 10-15 minutes

Use the Mobility Services Engine API to identify map, network, floor, and device information. At the end of this lab you should be able to use the API to quickly answer:

  1. What is the floor name?
  2. What is the floor size?
  3. How many access points are on the floor?
  4. How many clients are on the floor?
  5. What is a clients specific location?
  6. What is a clients last 10 reported locations?

Overview

Figure

The Mobility Services API is used to enhance and personalize different components of the Cisco Connected Mobile Experiences (CMX) solution.

The APIs are built into the Cisco Mobility Services Engine (MSE), which is a platform that helps organizations increase visibility into the network, customize location-based mobile services, and strengthen security.

The API is RESTful. Using the API, organizations can develop solutions that utilize real-time intelligence gathered from the Wi-Fi network to enable devices, people and technology to interact more effectively by integrating business processes with real-time contextual information about items such as location, temperature, availability of a user or mobile asset.

Via the API, all of the data collected can be made available to any business application that needs it, to allow full integration into the business processes of customers.

Pre-requisites

This lab requires that POSTMAN or some other web based REST client be used to make the REST API calls. If you're on a DevNet Zone station, POSTMAN is already installed and can be launched either from the Google App Launcher or from chrome by clicking here and hitting Launch App.

Figure

Step 1. Find the Mobility Services Engine (MSE) API Resources

  • In the browser navigate to Cisco MSE 10 REST Documentation Portal The API documentation is embedded into every installation of MSE 10 and it can be accessed by navigating to /apidocs on the MSE box.

Figure

The REST portal shows API documentation for each of the sections

  • Configuration : Use the Configuration REST APIs to configure different aspects of MSE.
  • Location : Use the Location based REST APIs to find location specific details on visitors.
  • Analytics : Use the Analytics based REST APIs to find analytical data on visitors.
  • Connect : Use the Connect based REST APIs to find user session information.

Try It Live

Figure

Users also have the ability to try the REST APIs "LIVE" without having to install any additional REST client software. The "Try It" option is a quick way to play with the REST APIs and get immediate feedback directly on the box.