topic Re: Using a web API through BluePrism in Product Forum

Using a web API through BluePrism

RikKotter — Tue, 02 May 2023 13:02:25 GMT

Hi!

For a project, we are trying to utilize a web API to approach a specific application.

The API seems to work, but we are having some trouble getting started on how to use this API through BluePrism.
How should we go about this? We've found the following file, but are quite overwhelmed. Is there a clearer explanation somewhere we could use?

v6.10 Web APIs - User Guide (blueprism.com)

Re: Using a web API through BluePrism

Babjee24 — Tue, 02 May 2023 13:23:19 GMT

Hi @Rik Kotter ,

You can use APIs in 2 different ways:
1. You can make use of Utility - HTTP. You'll have different API URLs for authentication, transaction data. Get authentication token first followed by the transaction URL.

2. Second way of doing it is from Systems Tab

you need to pass the base URL(this is common for all the methods available under the URL)

pass the URL that changes for each method and change the method type of the action as per your requirement and configure other parameters that are needed.

Hope this helps for you.

Re: Using a web API through BluePrism

ewilson — Tue, 02 May 2023 13:35:49 GMT

Hello @Rik Kotter

There are three mechanisms within Blue Prism that can be used for invoking a RESTful API (I assume when you say Web API you're referring to a RESTful API as opposed to a SOAP web service).

The Web API Service feature of Blue Prism (accessible from System -> Object -> Web API Services) is by far the easiest. The next option would be to use the Utility - HTTP VBO. Lastly, you can write custom code (VB or C#) in a Code stage.

What API are you trying to work with? Is it a public API (ex. Twitter API) or something internal to your company? If it's a public API, have you checked the Digital Exchange to see if there's already an existing connector for it?

NOTE: While the Web API Services feature is the easiest, it does have some limitations around downloading binary files that you should be aware of in case that's something you need to do.

Cheers,
Eric