Introduction to the AirWatch API
Currently, AirWatch supports both REST (Representational State Transfer) and SOAP (Simple Object Access Protocol) APIs. These APIs are used for developers creating their own applications that wish to invoke AirWatch functionality and utilize the information stored in their AirWatch environment. Introductions to Version 1 and 2 of the REST API as well as the SOAP API are given in the following section, with links to the official product documentation of each API included at the end of the article.
Note: When developing any new applications, AirWatch recommends the use of Version 2 of the REST API, both for ease of use and for optimal support long-term.
AirWatch provides a collection of RESTful APIs which allow external programs to use the core product functionality by integrating the APIs with existing IT infrastructures and third-party applications. Leveraging the simplified REST style of software architecture, AirWatch REST APIs currently include Organization Group, Console Administration, Mobile Application Management, Mobile Device Management, Mobile Email Management, Enrollment User Management, Profile Management, Smart Group Management, and User Group Management functionalities.
Leveraging REST-based APIs also allows several benefits to enterprises, including eliminated cost and time spent developing applications in-house. AirWatch APIs are fully able and ready to integrate with enterprise servers, programs and processes. Additionally, AirWatch APIs are efficient, run smoothly and are easily branded with enterprises. This guide is intended for application developers and provides an understanding of the design and architecture of the Version 1 and Version 2 REST APIs library to facilitate a custom development and integration with AirWatch.
REST API versions
The introduction of Smart Group assignment to Profiles necessitated the introduction of a new version in the REST APIs to maintain backwards compatibility. From 7.3 release onwards, you can assign profiles to the devices from the AirWatch Admin console using SmartGroups. Thus, AirWatch has introduced Version 2 REST APIs to utilize the SmartGroup assignment feature and recommends you to use these APIs henceforth.
With Version 2 REST APIs, there is an observable work flow process change affecting only the Version 2 Profile management APIs and not Version 2 Product management APIs. For better understanding, refer the table below for the difference between Version 1 and Version 2 profile management work flow:
- Version 1: Create Profile (Assignment filters provided in General Payload) > Install Profile on devices.
- Version 2: Create Smart Group > Create Profile (With the Smart Group details provided in General Payload) > Install Profile on devices.
Additionally, AirWatch provides a SOAP API that can be used to allow external programs to invoke the core production functionality. This collection of interfaces can be included directly in the application code. After the initial configuration, which involves configuring a valid and recognized client certificate within the application for use with authenticating against the API endpoint, requests are made by invoking specific function/method calls that have been included in the API.
For any new applications, AirWatch strongly recommends using the Version 2 REST API rather than the SOAP API, both for usability concerns and better support moving forward.