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:
- Register the REST Application in ProcessMaker
- Obtain an Access Token from OAuth 2.0
- Call endpoints ProcessMaker for:
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:
|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.|