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:
- Register the REST Application in ProcessMaker
- Obtain an access token from OAuth 2.0
- Call ProcessMaker endpoints for:
See this example to better understand how to use 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:
Retrieves a resource.
Inserts, updates, or extends a resource; may change the state of other resources.
Creates, updates, or replaces a resource.
Deletes a resource.
- Rest Vs Web Services. Rafael Navarro Marset. ELP-DSIC-UPV. 2006-2007. Retrieved 06-10-2014.
- CHAPTER 11. REST: Representational State Transfer. Randy J. Ray, Pavel Kulchenko. December 2002. Retrieved 06-10-2014.