Running a process with API Keys

Avatar

By Andrei Ciucean

updated about 1 month ago

Prerequisites

To run the process using a API Key we will require:

  • To generate an API Key in PROCESIO. If you don't know how to generate PROCESIO API keys read this.
  • PROCESIO API endpoints can be found here. Additionally we also provide Swagger for our Web API endpoints which can be tested here.
  • Postman for sending the request.

Running a process from PROCESIO using API keys

1) After generating the PROCESIO API key, you need to copy and save the key name & key value. Key value will be hashed after navigating off the page.

2) From the PROCESIO API documentation, we will be looking for the POST method for running a process.

As observed in Swagger, the endpoint /api/Projects/{id}/run requires three parameters:

  • Process ID (needs to be mentioned in the URL)
  • Workspace (needs to be mentioned in Headers)
  • Request body (JSON) 
    {
      "connectionId": "string"
    }

3) From within your PROCESIO Workspace, in the process listing tab, obtain the process ID for the process that you intend to run (hit the copy to clipboard button).

Additionally we will need the name of the Workspace under which the process was created. In the example below the name of the Workspace is: "Demo"

4) From within Postman configure the request.

  • Select Post Method mention the base URL and the endpoint
    • Base URL: https://webApi.procesio.app
    • Endpoint: /api/Projects/e6bb2d64-2f96-4e43-a84b-b25a08c0764d/run (includes the Process ID)
  • In Postman from Headers
    • include key & key name
    • value & key value
    • workspace & workspace name (example above "Demo")


  • In Postman from Body, raw
    • include: {  "connectionId""string"}
    • Select JSON

5) From Postman hit the send button in order to trigger the process for which you configured the request.

Did this answer your question?