This guide describes the Application Programming Interface (API) to Apperian’s EASE web services. Through HTTPS requests, you can harness the power of the EASE platform as part of a custom enterprise mobility solution.
For an overview of Apperian EASE and a complete library of documentation for the EASE administration console (the EASE Portal), visit the Apperian Documentation Center. Note that whenever using the API Reference, you can click the Apperian logo at the top left to link to the Apperian Documentation Center.
New to the Apperian API? Review Introduction for an overview of the API and how it works.
Ready to dig in? See the List of Interfaces below for a brief description of the available interfaces. Click on an interface for more detail, including a description of the resources you can call during a transaction and a sample request and response message. For a quick link to an index of all resources, click “routing table” at the top right of the page.
The examples in this guide use cURL, an open-source command line tool, to send HTTPS requests. These examples work on computers running Mac OS, Linux, or Cygwin (a collection of tools for running Linux apps on Windows). If you want to use cURL during your development and testing process, it is available at curl.haxx.se.
All the examples show URLs for the EASE NA (North America) production environment. There are different base URLs for the EU (Europe) and NA environments (see Base URL for API Resources). If you copy examples from this guide, be sure to use the correct URL.
Version 1.0 of Apperian API includes the interfaces listed below. In upcoming releases of the API, Apperian will build on this foundation to expose additional interfaces and resources.
|Applications API||Returns data about the native iOS, Android, and BlackBerry applications stored in the EASE database for your organization. You can request application data for a specific application or for all native applications in your organization.|
|Users API||Adds, updates, lists, and deletes EASE users.|
|Groups API||Adds, updates, lists and delets EASE groups.|
|Downloads and Installs API||Downloads applications from the EASE server to install them on user devices.|
|Push Notifications API||Uses the operating system’s push notification service to send messages to user devices.|
|App Inspections API||Initiates an application inspection and gets an inspection report that was previously generated for an app. An inspection is used to screen an app for risky behavior and vulnerabilities, such as malware, trojans, and intellectual property exposure.|
|Crowdsourcing Ideas API||Enables you to crowdsource ideas from your mobile users. Using this API, you can post a new idea, list ideas already stored in the database, and delete an idea.|