Apperian API Reference¶
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.
- Applications API
- App Inspections API
- Catalog API
- Categories API
- Devices API
- Crowdsourcing Ideas API
- Downloads and Installs API
- Groups API
- Organizations API
- Push Notifications API
- Reports API
- Reviews API
- Signing API
- Users API
- Controlling GET Responses
- Sending Requests for Affiliated (Child) Organizations
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.
Using this Guide¶
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.
List of Interfaces¶
The Apperian API includes the interfaces listed below. For a list of all of the individual resources (endpoints) available to you, click on “routing table” in the top right corner of this page.
|Applications API||Request metadata and statistical data for the native applications stored in EASE for your organization. Also use this API to enable/disable an application, delete an application, add/delete application screenshots, and download an app’s binary file.|
|App Inspections API||Initiate an application inspection and get 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.|
|Catalog API||Serve data to an App Catalog running on an end user’s device. This API can be used to authenticate a user and register the user’s mobile device, list and search for apps, and list categories.|
|Categories API||List all application categories in your organization, and add an application to one or more categories.|
|Devices API||List devices associated with a specific user.|
|Crowdsourcing Ideas API||Crowdsource ideas from your App Catalog users. Using this API, you can post a new idea, list ideas already stored in the database, and delete an idea.|
|Downloads and Installs API||Download applications from the EASE server to install them on user devices.|
|Groups API||Add, update, list, and delete EASE groups.|
|Organizations API||List details about the authenticated user’s organization. If the user is an administrator, this will include any affiliated organizations.|
|Push Notifications API||Use the operating system’s push notification service to send messages to user devices.|
|Reports API||Run any of the reports that can be viewed in the EASE Portal and return the data in JSON format.|
|Reviews API||Let App Catalog users rate (Like/Dislike) apps, review apps, and browse reviews from other users.|
|Signing API||List all signing credentials stored in EASE, add new signing credentials, and sign an app using a set of stored credentials.|
|Users API||Add, update, list, and delete EASE users.|