In the following sections you will be guided through the basic resources you need to know in order to start using ProcessMaker.

  1. ProcessMaker Basic Concepts
  2. Installation Requirements
  3. Supported Browsers
  4. Supported Stacks
  5. Frequently Asked Questions (FAQ)
  6. Glossary
  7. Roadmap

Choose the plataform that best suits for you in order to have ProcessMaker properly installed.

  1. ProcessMaker Generic Installation: 2.X.X, 2.8.0
  2. Linux
  3. ProcessMaker Windows Installation
  4. Other Installations
  5. Experimental Section:

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 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.

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 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.

 Current GA Version: The list of plugins below belong to ProcessMaker version 2.5.x and 2.8. To learn more about the Enterprise features of ProcessMaker version 2.8, please visit this page.

Productivity Tools Silver Gold Platinum
Custom Case List Builder
Simple Reporting
Advanced Dashboards
Version Upgrade Manager
Batch Routing from Inbox 
Case Scheduler FTP Monitor 
Workflow Actions via Emails Wizard 
External User Registration Wizard 
Service Level Agreements Manager 
Business Rules Engine 
Enterprise Data Search
Advanced Performance Monitor Dashboards (*) 
Case Archive/Restore  
Multi-Tenancy Management (**)  
Multiple Input Document Uploader 
PowerUp  
PowerUp Extended Fields  
Integration Tools & 3rd Party IntegrationsSilverGoldPlatinum
Advanced LDAP/AD sync
Knowledgetree DMS Connector 
SigPlus Signature Pads for Electronic Signatures 
Single Sign-On with Active Directory 
Microsoft Outlook Connector 
Pentaho Business Intelligence Connector  
  • (*) Advanced Performance Monitor Dashboards are included in Cloud Only for Gold and in Cloud & On-Site for Platinum plans.
  • (**) Not available in Cloud.

Additional Resources

Looking for a ProcessMaker's Enterprise Edition for a 30 day period on the cloud?. Read the guides below: