Please rate how useful you found this document: 
Average: 2.5 (4 votes)

Find all information about ProcessMaker and its products

ProcessMaker is commercial open source workflow and business process management software.

ProcessMaker Community and Enterprise Products

PROCESSMAKER PRODUCT
VERSION
RELEASE DATE
DOCUMENTATION
Community Edition 2.X View
  2.5.x January 14th, 2014
2.8 December 16th 2014 View
3.0 (BPMN Version) May 12th, 2015
Enterprise Edition 2.8 December 2014
ProcessMaker Plugins View Documentation

ProcessMaker API

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.

Available Version: 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. Authenticate using OAuth 2.0 (and login to ProcessMaker if necessary).
  3. Call ProcessMaker endpoints for administration, designer and cases.

See this example, to better understand how to use REST.

II. End Points
  1. REST API Administration (Apiary Documentation)
  2. REST API Designer (Apiary Documentation)
  3. REST API Cases (Apiary Documentation)