ProcessMaker's API uses REST (Representational State Transfer) to allow external scripts to remotely access and control ProcessMaker. It provides a large number of endpoints so that almost any action that can be done within the ProcessMaker interface can also be done remotely using REST. ProcessMaker functionality can be reimplemented in external web pages, desktop applications and remote scripts. Using ProcessMaker's REST API, custom interfaces can be created to access ProcessMaker. The REST endpoints can also be accessed within ProcessMaker through PHP code in triggers or JavaScript code in Dynaforms.

Available on: The REST API is available for versions 2.8 and 3.0 of ProcessMaker

In order to use ProcessMaker's REST API, follow these steps:

  1. Register the REST Application in ProcessMaker
  2. Obtain an access token from OAuth 2.0
  3. Call ProcessMaker endpoints for:
    1. Administration,
    2. Designer,
    3. Cases

See this example to better understand how to use REST.

Understanding REST

REST (Representational State Transfer) is a term introduced by Roy Fielding in his doctoral dissertation that strictly refers to a collection of principles for the design of network architectures. The term is frequently used to describe the direction of any interface transmitting specific data on a HTTP domain.

REST uses normal HTTP requests and responses, just like normal HTML, so it doesn't require any special protocols to function over the web. Each REST endpoint is a web address that provides access to a specific ProcessMaker service, such as getting a list of cases or creating a user. The REST endpoints are accessed using the following four HTTP methods:

Method Meaning
GET Retrieves a resource.
POST Inserts, updates, or extends a resource; may change the state of other resources.
PUT Creates, updates, or replaces a resource.
DELETE Deletes a resource.