ProcessMaker API Documentation
Script Central

Access ProcessMaker RESTful API Documentation

Access ProcessMaker RESTfulAPI documentation from your ProcessMaker instance.

Overview

View this ProcessMaker API documentation to quickly view how to use the ProcessMaker RESTful API without testing API endpoints.

Despite the ProcessMaker user interface, ProcessMaker operates entirely from a RESTful API. ProcessMaker Administrators and developers may want to access the ProcessMaker API documentation to understand how to use endpoints or to consider how to extend ProcessMaker functionality for their own use cases.

If you view the ProcessMaker API documentation while logged on to your ProcessMaker instance, you may also test API endpoints to see how they work. For example, view the curl command or URL to run a ProcessMaker API endpoint, the possible responses and returned schema structure, and other technical information how to use that API endpoint. To test API endpoints, you must be logged on as an authenticated ProcessMaker user.

You must have the following to test ProcessMaker API endpoints from the API documentation:

  • You must know the base URL to your ProcessMaker instance. Example: https://MyOrganization.processmaker.net/.

  • You must have a ProcessMaker user account so that the ProcessMaker API can authenticate you. See Create a New User Account.

  • You must be logged on to your ProcessMaker user account.

View the API Documentation

If you want to view how robust ProcessMaker functionality is and read how to use each API endpoint, you may view the ProcessMaker RESTful API documentation. However, since you are not viewing this documentation as an authenticated ProcessMaker user, you cannot test API endpoints. See Test API Endpoints from the API Documentation for that information.

View this ProcessMaker API documentation without testing API endpoints.

Test API Endpoints from the API Documentation

Follow these steps to test ProcessMaker RESTful API endpoints from the API documentation:

  1. ‚ÄčLog on to ProcessMaker.

  2. Open a new Web browser tab or window.

  3. Append api/documentation to the end of your ProcessMaker instance's base URL. Example: https://MyOrganization.processmaker.net/api/documentation. The ProcessMaker API documentation displays.

  4. Click the Expand operation iconfor the ProcessMaker API endpoint you want to test. Technical information about that API endpoint displays.

  5. Click the Try it out button, and then enter parameters documented for that API endpoint into their appropriate fields.

  6. Click Execute.

Related Topics