Before starting, ensure that the use of API's are enabled for your company.
To enable API's, contact ProcessPro support for assistance.
Read more about how to obtain API documentation.
Authorise and Navigate to Swagger
Generate and copy your API security token
Select API Documentation, located in the top middle of the page.
Swagger will open in a new tab
Select 'Authorize'
Paste the ProcessPro API token into the box and select 'authorize'. A notification will confirm authorisation
The padlock next to each item will be locked. When the padlocks are unlocked, it indicates that authorisation is required.
Quick Steps to Test an API
Select the API that you wish to test in Swagger and expand the details
Select 'Try it out'
Set the parameters
Select 'Execute'. The test will execute
If the request is successful, code 200 and the desired response will appear
If the request is unsuccessful, an error response will appear. Change the relevant parameters and retry.
