ProcessMaker Community Edition v. 3.0

Notice: This site will be down for maintenance from July 30th to August 1st. We apologize for any inconvenience this may cause. If you have any questions, please contact community@processmaker.com

Current Stable Version: 3.0.1.8 (May 11th, 2016)

Release Notes Version 3.0.1.8 | What is new? | RoadMap | Old Versions

Welcome to ProcessMaker BPM documentation. If you cannot find what you are looking for, please send an email to community@processmaker.com

  1. Installation Requirements
  2. Supported Browsers
  3. Supported Stacks
  4. Glossary
  5. Official Release, Hotfix and Patch Distribution Policies

Follow the instructions for your operating system in order to install ProcessMaker.
  1. Linux/UNIX:
  2. Windows:

Not Officially Supported Installations

Overview

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 which 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 by PHP code in triggers or JavaScript code in DynaForms.

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

  1. Register the REST Application
  2. Obtain an access token from OAuth 2.0
  3. Calling ProcessMaker endpoints for:

Additional resources:

Understanding REST

REST (Representational State Transfer) is a term introduced by Roy Fielding in his doctoral dissertation which 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 which 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:

MethodMeaning
GETRetrieves a resource.
POSTInserts, updates, or extends a resource; may change the state of other resources.
PUTCreates, updates, or replaces a resource.
DELETEDeletes a resource.