Paligo API

Abstract

Developers can use the Paligo API to get external applications to interact with Paligo remotely. The Paligo API allows applications to list and update content, start publishing and import processes remotely, and more.

The Paligo API is a public interface that provides access to several of Paligo's core features. Developers can use it to get external applications to interact with Paligo, for example, they can use it to automatically publish an output every day.

The following list shows the main areas that you can access through the Paligo API and the actions that can be performed.

  • Folders

    • List folders

    • Create new folders

  • Documents

    Documents applies to topics, publications, and the "forks" in publications.

    • List documents (shows metadata and XML content)

    • Update a document's name

    • Edit a document's XML content remotely (through the Paligo API).

  • Images

    • List images

    • Upload new images

    • Replace an existing image with a different image.

  • Publishing settings

    • List the existing saved publishing settings.

  • Productions

    • Start a new publication process (a "production")

    • List the recent productions

    • Download the output from a recent production.

  • Imports

    • List recent imports

    • Start a new import.

Developers can find information on the Paligo API, including details of its endpoints etc., in the Paligo API Documentation. It contains the information that developers need when programming external applications to interact with Paligo.

If you need to create an API key so that Paligo can recognize an external application, see API Keys.