This guide describes the application programming interface for the Apperian publishing web service. Use the publishing API to add applications to your organization and update existing applications—all without using the Admin Portal.
Apperian offers two APIs for managing apps:
The interface described in this guide, which is based on an older API framework.
A RESTful API which offers a more modern and efficient experience.
We recommend that all customers use the newer RESTful Applications API to add and manage your apps. For more information, see Applications API.
The API described in this guide will be deprecated later this year.
Using This Guide
This guide includes the following topics:
About the Publishing API provides an overview of the Apperian publishing API. Read this section first to gain a basic understanding of how the API works.
Using the Publishing API describes the transactions you can perform using the publishing API, including diagrams that step through the request/response workflow. Review this section when you are getting started with the API to understand the overall flow. Later, you may find the diagrams in this section to be a useful quick reference.
Methods provides details on each of the methods you will call during an API transaction, including a description of request parameters and example request and response messages. It also provides a cURL example for each method.
Error Codes describes the errors you may receive when you send a request to the publishing API.
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 Apperian EU (Europe) production environment. There are different base URLs for the EU and NA (North America) environments (see Exchanging JSON-RPC Messages). If you copy examples from this guide, be sure to use the correct URL.