Blue Prism Web API services - REST - Queries

[DipinDevP]

Hi,

I have few queries related on how to setup and use REST API calls in Blue Prism. My queries may be basic, but it would be great if anyone can help with answers.

1) What are the different methods to handle REST API services in Blue Prism? Can we use Utility HTTP object actions or Web API Services under System tab is the only option?
2) I have to do login API call to get the bearer token for further requests. Please help me to understand how can I setup this in Blue Prism.

Request:

Endpoint url: https://xx.xx.x.x:xxx/api/authenticate/login
Method: POST
Body should contain below data with type x-www-form-urlencoded:
grant_type = xxxxx
username = xxx
password = xxxxxxxxx

Response format:
{
"access_token": "xxxx",
"token_type": "bearer",
"expires_in": 1234
}
3) After getting bearer token (access_token) I need to use this in all further requests and this bearer token may change frequently. How can I setup this?
4) I need to add a parameter filter.includeNotes, but while I am trying to do this error showing as full stop (.) not allowed in parameter name. How can we handle this?

This is bit urgent. Answer to above queries and all related information would be helpful.

Thanks,
Dipin Dev P

[DipinDevP]

@devneetmohanty07 @Denis__Dennehy @Chakkravarthi_PR @Neel1 @harish.mogulluri 
It would be great if you can help with suggestions and practical examples!

[SayeedBinAbdullah]

Hi @DipinDevP 

1. Blue Prism provides two main approaches:
   

   Utility - HTTP Object Actions: This can be used to send HTTP requests directly, providing flexibility but requiring manual handling of headers, request types, and responses.
   Web API Services (System Tab): This is the recommended method for REST API calls as it allows structured setup and configuration. It helps maintain API calls centrally and provides automatic handling of requests, responses, and authentication.

2. To setup API you can refer to below documentation from Blueprism where detailed steps with screenshots are available.
   https://docs.blueprism.com/en-US/bundle/next-generation/page/design-studio/system/web-api-services.htm 
3. Store the access_token in a Blue Prism Environment Variable or Config File so that it can be updated when changed. 
   
4. Blue Prism does not support dots (.) in parameter names, instead you can try to use [filter][includeNotes] format in parameters.

Best Regards,
Sayeed Bin Abdullah