REST API

You can start a process using the REST API. Just open the “Start process” step and navigate to the “REST API” tab.

cURL

You can quickly test the REST API using curl. Just copy the command sample from the “cURL” tab and replace the JSON object in the -d parameter with your data. Then execute it using curl.

Forms designer

PowerShell

You can quickly test the REST API using PowerShell. Just copy the code sample from the “PowerShell” tab and replace the $JSON variable with your data. Then execute it using the command line or PowerShell ISE.

Forms designer

Your programming language

In a production environment you may prefer using your programming language for starting processes.

Our API is REST-based. Thus, you can use any programming language that can execute web requests. For example, you would use C#, node.js, Python, PHP.

There are a lot of ready to use helper REST API clients for those languages. Here are just a few of them:

Just review the structure of the HTTP request in the curl sample above and compose a request using your programming language.

Note

In addition to starting processes, Plumsail Documents API provides many more operations. Review the API reference and documentation.

Also, you can start your process using Web form or Power Automate (Microsoft Flow).