API Integration

How to make call to our API's in order to run robots remotely and get the result.

How the process should take place step-by-step:

1. Create a user profile;

2. Sign in using the GET Login method, thus retrieving the authentication token;

3. All the following executions should be passed in Header Authorization: Bearer which is the response retrieved at login time;

4. Obtain the Runtime's unique ID by contacting our support;

5. Obtain the unique ID of the robot that will be executed by contacting support;

6. Execute the POST Run or GET Run method with the above data and get the code from the request that will come as a result;

7. Get the response with the GET Result method, passing the Runtime code and the code of the result retrieved earlier.

Authentication

POST https://app.rpaidea.com/api/user/auth

Logging into the system using auth2 "Bearer authentication".

Headers

Name	Type	Description
Content-Type	string	application/json

Request Body

Name	Type	Description
	object	{ "username": "[email protected]", "password": "base64_encoded_password" }

200 Success.

Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJpbnRlZ3JhY2FvX2ZvcmdlQGFnYXB5cy5jb20iLCJpc3MiOiJST0xFX0lOVEVHUkFUSU9OLCIsImV4cCI6MTU3NTgyOTU5Nn0.655IJVQOierSDDe3Yf5tcZo4htpvQPSMAwq4OtdQ4ZycfBF7bP8JssWQe3m7Ad17066SWURArJ7OrjAe-mNyDA

401 Unauthorized user.

{
  "timestamp": 1574970103297,
  "status": 401,
  "error": "Unauthorized",
  "message": "Unauthorized",
  "path": "/api/user/auth"
}

Authentication V2

POST https://app.rpaidea.com/api/user/v2/auth

Sign in to the system uses the OAuth 2.0 standard.

Headers

Name	Type	Description
	string	application/json

Request Body

Name	Type	Description
	object	{ "username": "[email protected]", "password": "base64_encoded_password", }

200 Success

{
  "access_token": "jwt_token",
  "token_type": "bearer",
  "expires_in": 2592000
}

401 Unauthorized user

{
  "timestamp": 1574970103297,
  "status": 401,
  "error": "Unauthorized",
  "message": "Unauthorized",
  "path": "/api/user/auth"
}

Run robot with parameters

POST https://app.rpaidea.com/api/integration/v1/run/{ID_COMPUTER}/{ID_ROBOT}

Asynchronous execution start of the robot on the indicated Runtime, returning the execution id for future result request.

Headers

Name	Type	Description
Authorization	string	Bearer {RESULT-OF-LOGIN}
Content-Type	string	application/json

Request Body

Name	Type	Description
	object	{ "variables": [ { "name":"CNPJ", "type": "text", "value":"{VALUE}" }, { "name":"IE", "type": "text", "value":"{IE}" } ] }

200 Success

{ID_EXECUTION}

401 Unauthorized user.

{
  "timestamp": 1574970103297,
  "status": 401,
  "error": "Unauthorized",
  "message": "Unauthorized",
  "path": "/api/user/auth"
}S

Run robot with parameters v2

POST https://app.rpaidea.com/api/integration/v2/run/{ID_COMPUTER}/{ID_ROBOT}

Asynchronous execution start of the robot on the indicated Runtime, returning the execution id for future result request.

Headers

Name	Type	Description
Authorization	string	Bearer {RESULT-OF-LOGIN}
Content-Type	string	application/json

Request Body

Name	Type	Description
	object	{ "variables": [ "name": "CNPJ", "type": "text", "value": "{VALUE}" ] }

200 Success

{
  "id": "execution_id",
}

Run Robot

GET https://app.rpaidea.com/api/integration/v1/run/{ID_COMPUTER}/{ID_ROBOT}

Asynchronous execution start of the robot on the indicated Runtime, returning the execution id for future result request, but without parameters (uses the default parameters).

Headers

Name	Type	Description
Authorization	string	Bearer {RESULT-OF-LOGIN}
Content-Type	string	application/json

200 Success

{ID_EXECUTION}

401 Unauthorized user.

{
  "timestamp": 1574970103297,
  "status": 401,
  "error": "Unauthorized",
  "message": "Unauthorized",
  "path": "/api/user/auth"
}

Run Robot v2

POST https://app.rpaidea.com/api/integration/v2/run/{ID_COMPUTER}/{ID_ROBOT}

Asynchronous execution start of the robot on the indicated Runtime, returning the execution id for future result request, but without parameters (uses the default parameters).

Headers

Name	Type	Description
Authorization	string	Bearer {RESULT-OF-LOGIN}
Content-Type	string	application/json

200 Success

{
  "id": "execution_id",
}

Get execution result

GET https://app.rpaidea.com/api/integration/v1/result/{ID_COMPUTER}/{ID_EXECUTION}

Busca o resultado de forma parcial ou total da execução do robô - Gets the result of the robot's execution

Headers

Name	Type	Description
Authorization	string	Bearer {RESULT-OF-LOGIN}
Content-Type	string	Application/json

200 Success

{
  "_id": "7babeddae035ea1a",
  "logs": [],
  "init": 1574975771692,
  "end": null,
  "returnValue": null,
  "status": "PENDENT",
  "progress": 0.0
}

Delete task from queue

DELETE https://app.rpaidea.com/api/integration/v1/delete/{ID_COMPUTER}/{ID_EXECUTION}

Deletes tasks that have been added to the queue.

Headers

Name	Type	Description
Authorization	string	Bearer {RESULT-OF-LOGIN}
Content-Type	string	Application/json

200 Success