Introduction

The Apperian App Management API is a REST API, which means that you can use standard HTTP methods (GET, POST, PUT, and DELETE) to retrieve, submit, change, and delete data. To ensure data privacy, the API is served over HTTPS; unencrypted HTTP is not supported.

How It Works

Each interface provides a set of API resources that let you perform various mobile application management tasks. Each resource has a URL (or endpoint) on the Apperian server. To call a resource, you send an HTTPS GET, POST, PUT, or DELETE request to the appropriate URL, and the Apperian server responds with JSON-formatted data. When you send a POST or PUT request, the body of data you submit must be sent as JSON by specifying a Content-Type of application/json in the HTTP header.

Your code can be written with any tools capable of sending HTTP requests. The examples in this reference use cURL, an open-source command line tool. If you want to use cURL to interact with the API during your development process, it is available at curl.haxx.se.

Base URL for API Resources

Each API resource has the same base URL. There is a different base URL for each Apperian hosted production environment. If you are not sure which hosted production environment you should use, check with Customer Support.

Environment Base URL
North America https://na01ws.apperian.com/
Europe https://eu01ws.apperian.eu/

If you are working with an on premise or custom implementation of Apperian, check with your IT administrator who manages the installation to obtain the correct base URL.

API Version

Some resources include a v1 version only, while others may include v1, v2, or v3 versions. When you send a request to an Apperian API resource, you should include the version in the resource URL. For example:

https://na01ws.apperian.com/v2/applications/app_catalogs/

Pointing to a specific version ensures that your codebase is backwards-compatible in the event that a new version of a resource becomes available in the future.

When writing new code, always point to the latest version of a resource. If you have existing code that references a v1 version of a resource that now has a newer version available, the v1 resource will still work but you should update your code to point to the newest version.

Older versions may be supported for a period of time, but they are eventually deprecated. Any older resource that now has a new version available includes an Attention note in its documentation that identifies the new resource and the timeframe for deprecating the older version.

Authentication

Every request sent through the Apperian API must include a valid access token. An access token is a unique string that identifies a user and grants access based on their permissions.

There are two types of tokens used to access the Apperian API:

  • API Tokens
  • User Tokens

For more information, see Authentication.

Controlling GET Responses

When you send a GET request to the following resources, you can specify parameters to search, sort, and paginate the JSON data returned in the response:

  • GET /users
  • GET /applications
  • GET /groups

For instructions on searching, sorting, and paginating GET responses, see Controlling GET Responses.